Developers
Criar chave de APIEntrar na plataforma

Criar contato

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

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

Escopo: contatos:write · Área: Contatos · Testar no navegador

Se já existir contato com o mesmo WhatsApp ou e-mail, o existente é devolvido (sem duplicar).

Corpo

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

CampoTipoDescrição
nome obrigatóriostringNome
whatsapp stringWhatsApp com DDI (informe whatsapp e/ou email)
email stringE-mail
sobrenome string—
cpf_cnpj string—
etiquetas string[]—
campos_customizados object—

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/contatos" \
-H "Authorization: Bearer $ASTRIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"nome": "Ana",
"sobrenome": "Souza",
"whatsapp": "5541999990000",
"email": "ana@exemplo.com"
}'
const res = await fetch('https://api2.astrify.com.br/v1/contatos', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.ASTRIFY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"nome": "Ana",
"sobrenome": "Souza",
"whatsapp": "5541999990000",
"email": "ana@exemplo.com"
}),
});
console.log(res.status, await res.json());
import os, requests
r = requests.post(
"https://api2.astrify.com.br/v1/contatos",
headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"},
json={
"nome": "Ana",
"sobrenome": "Souza",
"whatsapp": "5541999990000",
"email": "ana@exemplo.com",
},
timeout=20,
)
print(r.status_code, r.json())

Resposta

Status 200, em JSON:

{
"success": true,
"contato": {
"id": "3f9c2b1e-8a4d-4c71-9e0b-5d2a7c6f1b34",
"nome": "Ana",
"sobrenome": "Souza",
"whatsapp": "5541999990000",
"email": "ana@exemplo.com",
"etiquetas": [
"cliente"
],
"cpf_cnpj": null,
"campos_customizados": {},
"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.