Captura de leads
Contato e oportunidade criados numa chamada só.
2 rotas. Todas exigem a chave de API no header Authorization, salvo quando marcadas como públicas. Abrir este módulo no Swagger.
Criar contato e oportunidade numa chamada
POST /companie/captured/lead/api
Cria o contato (ou reaproveita um existente com o mesmo e-mail ou WhatsApp) e abre uma oportunidade.
- Sem
funnel_step_id, a oportunidade entra na etapa definida na automação de entrada do tipo API (Configurações › Automações). - Os campos
campaign_*registram a origem do lead (UTM). - A resposta é o
idda oportunidade. Se já existir oportunidade aberta para o contato, devolve oiddela.
Corpo (application/json)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | sim | |
email | string | ||
whatsapp | string | ||
date_expectation | string | ||
funnel_step_id | número ou null | ||
obs | string | ||
campaign_project | string | ||
campaign_city | string | ||
campaign_state | string | ||
campaign_utm_source | string | ||
campaign_utm_medium | string | ||
campaign_utm_campaign | string | ||
campaign_utm_term | string | ||
campaign_utm_content | string | ||
campaign_version | string | ||
campaign_message | string | ||
campaign_investment | string |
Respostas
| Status | Descrição |
|---|---|
200 | Id da oportunidade. |
400 | Parâmetros inválidos. (ValidationError) |
401 | Chave ausente, inválida, revogada ou vencida. (ErrorCode) |
403 | Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode) |
404 | error_companie_id_not_exist ou error_funnel_step_not_exist (ErrorCode) |
409 | error_settings_form_not_exist: falta a automação de entrada do tipo API. (ErrorCode) |
429 | Limite de requisições excedido. (ErrorCode) |
Receber lead de formulário público
POST /companie/captured/lead/api/v2
Rota pública
Não exige chave de API.
Rota pública, usada pelos formulários gerados em Integrar Formulário. Exige companie_id no corpo e a automação de entrada do tipo formulário. Para integrações de sistema, prefira POST /companie/captured/lead/api com a chave de API.
Corpo (application/json)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | sim | |
email | string | ||
whatsapp | string | ||
date_expectation | string | ||
birth | string | ||
companie_id | número | sim | |
funnel_step_id | número ou null | ||
segment_id | número ou null | ||
sales_channel_id | número ou null | ||
activitie_id | número ou null | ||
product_id | número ou null | ||
obs | string | ||
campaign_project | string | ||
campaign_city | string | ||
campaign_state | string | ||
campaign_utm_source | string | ||
campaign_utm_medium | string | ||
campaign_utm_campaign | string | ||
campaign_utm_term | string | ||
campaign_utm_content | string | ||
campaign_version | string | ||
campaign_message | string | ||
campaign_investment | string | ||
state | string | ||
city | string | ||
address | string | ||
zipcode | string | ||
document | string | ||
gender | string | ||
identity | string | ||
civil_status | string | ||
registration_number | string | ||
tag_ids | número[] | ||
origin | form | ||
companie_user_id_indication | número ou null | ||
company_user_id | número ou null | ||
companie_user_id | número ou null |
Respostas
| Status | Descrição |
|---|---|
200 | Id da oportunidade. |
400 | Parâmetros inválidos. (ValidationError) |
409 | error_companie_id_not_exist ou error_settings_form_not_exist (ErrorCode) |