v1 · pronta para produção

ARVEX Leads API

Receba leads do RD Station, formulários externos, ferramentas de tráfego pago e CRMs. Cada lead dispara o evento de automação new_lead_received.

Endpoint

POST/api/public/leads

Autenticação

Envie sua chave de API no cabeçalho x-api-key em todas as requisições.

x-api-key: SUA_CHAVE_ARVEX

Corpo da requisição

Campo	Tipo	Descrição
`name`obrigatório	string	Nome completo do lead
`phone`obrigatório	string	Telefone BR em formato livre (ex.: +55 11 99999-0000)
`email`opcional	string	E-mail do lead
`source`opcional	string	Origem (ex.: rd_station, facebook_ads)
`tag`opcional	string	Tag de campanha ou segmentação
`notes`opcional	string	Observações livres (máx. 2000 caracteres)

Exemplo de requisição

curl -X POST https://SEU-DOMINIO/api/public/leads \
  -H "Content-Type: application/json" \
  -H "x-api-key: SUA_CHAVE_ARVEX" \
  -d '{
    "name": "Maria Silva",
    "phone": "+55 11 99999-0000",
    "email": "maria@example.com",
    "source": "rd_station",
    "tag": "campanha_setembro",
    "notes": "Interessada em avaliação"
  }'

Resposta · 201 Created

{
  "success": true,
  "message": "Lead received successfully",
  "lead_id": "uuid"
}

Comportamento

• Valida name e phone (obrigatórios).
• Deduplica leads com mesmo phone + email nas últimas 24h.
• Persiste o lead na tabela leads.
• Dispara o evento de automação new_lead_received com o payload completo do lead.

Códigos de erro

400	Corpo JSON inválido
401	x-api-key ausente ou inválida
422	Falha de validação (veja errors)
500	Erro de banco de dados ou servidor