Skip to main content

​
Quickstart

Siga os passos abaixo para criar seu primeiro lead via API.

​
Pre-requisitos

  • Uma conta no TroiaChat com acesso ao painel administrativo
  • Um funil configurado no CRM com pelo menos uma etapa
1

Gere sua API Key

No painel do TroiaChat, acesse Configuracoes > API Keys e clique em Criar nova chave.Copie a chave gerada — ela so sera exibida uma vez.
Guarde sua API Key em local seguro. Ela da acesso a criacao de leads na sua conta.
2

Encontre o Step ID do funil

No painel do TroiaChat, acesse CRM > Funis, selecione o funil desejado e copie o ID da etapa onde os leads devem ser criados.
3

Envie sua primeira requisicao

Substitua SUA_API_KEY e SEU_STEP_ID pelos valores obtidos nos passos anteriores.
curl -X POST https://api.troiachat.com/api/leads/public/SEU_STEP_ID \
  -H "Content-Type: application/json" \
  -H "X-API-Key: SUA_API_KEY" \
  -d '{
    "name": "Joao Silva",
    "phones": ["5511999999999"],
    "segment": "Teste"
  }'
4

Verifique o resultado

Se a requisicao for bem-sucedida, voce recebera uma resposta 201 com os dados do lead criado:
{
  "success": true,
  "data": {
    "id": "663f1a2b3c4d5e6f7a8b9c0d",
    "contactId": "663f1a2b3c4d5e6f7a8b9c0e",
    "segment": "Teste",
    "status": "new",
    "priority": "medium",
    "temperature": "cold",
    "source": "direct",
    "medium": "organic",
    "channel": "other",
    "createdAt": "2026-04-12T14:30:00.000Z"
  },
  "message": "Created successfully"
}
O lead aparecera automaticamente no funil do CRM com o contato criado.

​
Proximo passo

Autenticacao

Entenda como funciona a autenticacao e gerencie suas API Keys.

API Reference

Veja a referencia completa com todos os campos disponiveis.