Pular para o conteúdo principal
POST
Registrar um lead de campanha

Parâmetros de consulta

workspaceId
string | null

Obrigatório ao chamar de um navegador. Uma solicitação CORS preflight não tem corpo, portanto o tenant não pode ser resolvido nem Access-Control-Allow-Origin pode ser devolvido a menos que o workspace esteja na URL. Chamadas de servidor para servidor não fazem preflight e podem omiti-lo.

Corpo

application/json

Contrato de comunicação de POST api/v1/leadscout/campaign-leads.

workspaceId
string
obrigatório
captureKey
string
obrigatório
cellphone
string
obrigatório
landingUri
string
obrigatório

Declaração do tenant de que o visitante deu permissão para receber mensagens.

Isto NÃO é CommercialConsentState, nosso registro do ciclo de vida do consentimento de um contato. É uma afirmação externa que não podemos verificar: comprova o que nos foi informado e quando, que é o que apresentaríamos se o portfólio de um tenant fosse restringido.

recaptchaToken
string
obrigatório
name
string | null
brandId
string | null
utm
Utm · object

Resposta

Aceito e na fila. NÃO enviado: um serviço separado transmite a primeira mensagem depois.

Corpo da resposta 202 Accepted.

Tem um nome em vez de ser apenas um dict[str, str] para que o schema publicado informe qual é o único campo e para que serve, em vez de “um objeto com propriedades de texto”.

requestId
string
obrigatório

ID de correlação deste envio. Presente apenas na aceitação; as respostas de erro não incluem um.