Quickstart
Em poucos minutos: gere uma API Key e crie seu primeiro lead com um único curl.
Este guia leva você do zero a um lead criado no CRM usando apenas curl.
O que você vai precisar
- Uma API Key do seu workspace (formato
vnd_...). - A URL base do seu projeto:
https://<seu-projeto>.supabase.co/functions/v1(referida como{BASE_URL}aqui).
1. Gere uma API Key
As chaves são criadas dentro do app, por um usuário administrador ou gestor do workspace:
Abra o Vendee e vá em Configurações → Integrações / API.
Clique em Nova chave, dê um nome (ex.: "Formulário do site") e escolha os
escopos (permissões). Para o lead deste guia, basta leads:write.
Copie a chave gerada. Ela é exibida uma única vez — o CRM guarda apenas um hash e não consegue mostrá-la de novo. Se perder, gere outra.
Trate a API Key como uma senha. Quem tem a chave age no seu workspace dentro dos escopos dela. Se vazar, revogue no mesmo lugar onde foi criada e gere uma nova.
Veja Chaves e escopos para o catálogo completo de permissões.
2. Crie seu primeiro lead
Troque vnd_sua_chave_aqui pela sua chave e {BASE_URL} pelo host do seu projeto:
curl -X POST "{BASE_URL}/api-v1-leads" \
-H "X-API-Key: vnd_sua_chave_aqui" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Maria",
"last_name": "Silva",
"email": "[email protected]",
"company_name": "Empresa Exemplo",
"source": "site",
"external_id": "form-123"
}'Apenas first_name é obrigatório. Todos os outros campos são opcionais — veja a lista
completa em Leads.
3. A resposta
Em uma criação nova, a API responde 201 Created:
{
"lead": {
"deal_id": "8f3c...",
"contact_id": "1a2b...",
"company_id": "9d8e...",
"workspace_id": "44c1...",
"status": "aberto",
"pipeline_id": "7b6a...",
"stage_id": "0f1e...",
"owner_id": "3c2d...",
"created_at": "2026-06-27T12:00:00.000Z"
},
"idempotent": false,
"created": { "company": true, "contact": true, "deal": true }
}4. O que aconteceu no CRM
A partir do payload, o Vendee resolveu tudo sozinho:
- Empresa "Empresa Exemplo" criada (ou reaproveitada).
- Contato "Maria Silva" criado e vinculado à empresa.
- Negócio criado com
status: "aberto", no pipeline padrão e na primeira etapa, com um responsável atribuído automaticamente.
Se você reenviar o mesmo external_id, a API não duplica: responde 200 OK com
"idempotent": true e os mesmos ids. Isso torna seguro reenviar em caso de timeout.