Skip to main content

​
Pré-requisitos

  • Conta no Vistum com plano Growth ou PRO
  • Uma instância de WhatsApp conectada no workspace
  • Acesso às configurações de Desenvolvedor no CRM

​
1. Gere uma API Key

1

Abra as Configurações

No CRM, clique em Configurações → Desenvolvedor → API Keys.
2

Crie uma nova chave

Clique em Nova API Key, dê um nome descritivo (ex: n8n-producao) e salve.
3

Copie a chave

A chave é exibida uma única vez. Copie e guarde em local seguro.Ela tem o formato: vg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
2. Envie seu primeiro lead

curl -X POST https://crm.vistum.com.br/api/v1/leads \
  -H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "11999887766",
    "name": "Maria Silva",
    "email": "maria@exemplo.com",
    "pipeline": "Vendas",
    "stage": "Novo Lead",
    "origin": "quickstart"
  }'

​
3. Interprete a resposta

{
  "ok": true,
  "action": "created",
  "contact": {
    "id": "cnt_abc123",
    "name": "Maria Silva",
    "phone": "5511999887766",
    "email": "maria@exemplo.com"
  },
  "card": {
    "id": "card_xyz789",
    "stageId": "stage_def456",
    "origin": "quickstart"
  }
}
  • action: "created" — novo contato e card criados
  • action: "updated" — contato já existia, dados atualizados

​
Próximos passos

Referência completa do endpoint

Todos os campos disponíveis

Receber eventos com Webhooks

Saiba quando um lead avança no pipeline