Pular para o conteúdo principal

Enviar um lead do CRM

POST /v1/inbound/leads

curl -X POST "https://api.conversaas.com.br/v1/inbound/leads" \
-H "Authorization: Bearer SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"source": "typeform-black-friday",
"name": "Maria Souza",
"email": "maria@loja.com.br",
"phone": "+55 11 91234-5678",
"company": "Loja da Maria",
"tags": ["black-friday"],
"customFields": { "plano_interesse": "pro" },
"attribution": { "utmSource": "google", "utmCampaign": "bf2026" }
}'

Resposta:

{ "result": "created", "id": "9f1c2e7a-..." }

Campos​

CampoDescrição
sourceObrigatório. Texto curto que identifica de onde veio o dado
email e phoneEnvie pelo menos um dos dois. O telefone é guardado só com dígitos (8 a 15)
name, company, titleOpcionais
externalRef{ "system": "meu-erp", "id": "123" }. Identificador do registro no sistema de origem. Evita duplicar mesmo que telefone ou e-mail mudem
tagsLista de etiquetas (até 20)
customFieldsCampos extras simples (até 30). Valores só texto, número, verdadeiro/falso ou vazio
notesObservação livre
attributionutmSource, utmMedium, utmCampaign, utmTerm, utmContent, referrer, landingUrl
consent{ "accepted": true, "text": "...", "at": "2026-10-01T12:00:00Z" }. Obrigatório quando a chave exige consentimento
occurredAtQuando o evento aconteceu na origem (data ISO 8601)
ownerE-mail de um usuário seu para ser o responsável (só chave secreta)
stageEtapa do funil, se a chave permitir (só chave secreta)

Campos que a API não conhece são recusados, para você descobrir erros de digitação logo no teste.