Developers
Criar chave de APIEntrar na plataforma

Criar lead

Rota de Leads da API aberta da Astrify Flows: parâmetros, exemplos em curl, Node.js e Python, resposta e erros.

POSThttps://api2.astrify.com.br/v1/leads

Escopo: leads:write · Área: Leads · Testar no navegador

Se o funil tem roleta ligada, o responsável é definido automaticamente. Dispara os Workflows de “lead criado”.

Corpo

JSON, com o cabeçalho Content-Type: application/json.

CampoTipoDescrição
nome obrigatóriostringNome do lead
funil_id obrigatóriouuidFunil (da sua empresa)
etapa_id obrigatóriouuidEtapa do funil
email stringE-mail
telefone stringTelefone/WhatsApp
empresa stringEmpresa do lead
cargo stringCargo
valor_estimado numberValor do negócio
temperatura stringfrio, morno ou quente
responsavel_id uuidUsuário responsável
contato_id uuidVincula a um contato existente
tags string[]Etiquetas
origem stringOrigem do lead
campanha stringCampanha
previsao_fechamento dateAAAA-MM-DD
observacoes stringObservação inicial
campos_customizados objectCampos personalizados (chave → valor)

Exemplo de requisição

A chave vem da variável de ambiente ASTRIFY_API_KEY. Troque os marcadores em maiúsculas (comoLEAD_ID) por ids da sua empresa.

Terminal window
curl -X POST "https://api2.astrify.com.br/v1/leads" \
-H "Authorization: Bearer $ASTRIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"nome": "Ana Souza",
"email": "ana@exemplo.com",
"telefone": "5541999990000",
"funil_id": "b2e6a4d8-1c53-47f9-a8e0-3d7c5b91f402",
"etapa_id": "c4b8f2a9-6d17-4e35-b0a2-91f3d85c7e10",
"valor_estimado": 4500,
"tags": [
"site"
]
}'
const res = await fetch('https://api2.astrify.com.br/v1/leads', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.ASTRIFY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"nome": "Ana Souza",
"email": "ana@exemplo.com",
"telefone": "5541999990000",
"funil_id": "b2e6a4d8-1c53-47f9-a8e0-3d7c5b91f402",
"etapa_id": "c4b8f2a9-6d17-4e35-b0a2-91f3d85c7e10",
"valor_estimado": 4500,
"tags": [
"site"
]
}),
});
console.log(res.status, await res.json());
import os, requests
r = requests.post(
"https://api2.astrify.com.br/v1/leads",
headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"},
json={
"nome": "Ana Souza",
"email": "ana@exemplo.com",
"telefone": "5541999990000",
"funil_id": "b2e6a4d8-1c53-47f9-a8e0-3d7c5b91f402",
"etapa_id": "c4b8f2a9-6d17-4e35-b0a2-91f3d85c7e10",
"valor_estimado": 4500,
"tags": [
"site",
],
},
timeout=20,
)
print(r.status_code, r.json())

Resposta

Status 200, em JSON:

{
"success": true,
"lead": {
"id": "3f9c2b1e-8a4d-4c71-9e0b-5d2a7c6f1b34",
"nome": "Ana Souza",
"email": "ana@exemplo.com",
"telefone": "5541999990000",
"empresa": "Souza Ltda",
"valor_estimado": 4500,
"temperatura": "morno",
"status": "aberto",
"funil_id": "b2e6a4d8-1c53-47f9-a8e0-3d7c5b91f402",
"etapa_id": "c4b8f2a9-6d17-4e35-b0a2-91f3d85c7e10",
"responsavel_id": "a1d7e5c0-2b93-4f68-8c15-7e4b9d03f2a6",
"tags": [
"site"
],
"origem": "Site",
"created_at": "2026-10-01T14:32:10.123456+00:00",
"updated_at": "2026-10-01T14:32:10.123456+00:00"
}
}

Erros

StatusQuando acontece
401Chave ausente, inválida, expirada ou revogada.
403Sem o escopo exigido, cargo sem permissão, IP não autorizado ou registro de outra empresa.
422Corpo ou parâmetro com formato inválido. O detail lista os campos com problema.
429Limite de 120 requisições por minuto da chave. Espere o tempo do cabeçalho Retry-After.

O formato dos erros e as retentativas estão em Limites de uso e erros.

Digite para pesquisar em toda a documentação.