Páginas da documentação

Desenvolvedores · Guia · v1.2.0

Leads no seu CRM

Receber cada lead na hora, devolver a venda e fechar o ciclo com a Meta.

https://leadgo.com.br/api/v1 Baixar arquivo para IA OpenAPI 3.1 Criar token

Receber cada lead na hora

Cadastre um webhook com lead.created, lead.scored e lead.status_changed. O lead chega com nome, e-mail, telefone, as respostas do formulário e a campanha de origem; a nota da IA (quente, morno ou frio), com a mensagem sugerida para o primeiro contato, chega logo depois em lead.scored.

POST /webhooks
curl -X POST "https://leadgo.com.br/api/v1/webhooks" \
  -H "Authorization: Bearer $LEADGO_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://crm.exemplo.com.br/hooks/leadgo",
    "events": [
        "lead.created",
        "lead.scored",
        "lead.status_changed"
    ]
}'

Na primeira carga, ou para conferir se algum ficou para trás, liste com GET /leads?received_from=AAAA-MM-DD e pagine pelo cursor. Grave o id do lead no seu CRM para as próximas chamadas.

Devolver o resultado

Quando o vendedor avançar o lead no seu CRM, avise a API. Nos planos com inteligência de leads, a qualificação e a venda vão para a Meta, que passa a buscar gente parecida com quem compra, e os compradores entram no público semelhante.

No seu CRM Chamada
Primeiro contato POST /leads/{id}/contacted
Lead bom, em negociação PATCH /leads/{id} com status qualified
Venda fechada PATCH /leads/{id} com status won e value_cents
Não fechou PATCH /leads/{id} com status lost e lost_reason
Contato falso ou repetido PATCH /leads/{id} com status spam
Anotação do vendedor POST /leads/{id}/notes
PATCH /leads/{id}
curl -X PATCH "https://leadgo.com.br/api/v1/leads/01jbz2k8m4q0t6w2y8b4e0h6na" \
  -H "Authorization: Bearer $LEADGO_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "won",
    "value_cents": 25900
}'

Mudanças feitas no painel também chegam em lead.status_changed: use o previous_status para não devolver ao CRM o que veio dele.

Dados pessoais (LGPD)

  • Tokens com leads:read leem dados pessoais: dê esse escopo só às integrações que precisam.
  • Pedido do titular para apagar: DELETE /leads/{id} apaga o lead e o histórico aqui (na Meta, os leads expiram em 90 dias).
  • GET /leads/stats traz os números do funil sem dado pessoal, para painéis e relatórios.