Adicionar contatos à lista (com consentimento)
Rota de E-mail da API aberta da Astrify Flows: parâmetros, exemplos em curl, Node.js e Python, resposta e erros.
POSThttps://api2.astrify.com.br/v1/email/listas/{lista_id}/contatos
Escopo: email:write · Área: E-mail · Testar no navegador
{consentimento_confirmado: true, texto_consentimento?, contatos: [{email, nome?}]} (até 500). Quem está na supressão (bounce/spam) é ignorado; quem tinha cancelado volta SÓ porque a integração afirma ter o novo consentimento (fica no log).
Parâmetros de caminho
| Nome | Tipo | Descrição |
|---|---|---|
lista_id obrigatório | string | Id de lista. |
Corpo
JSON, com o cabeçalho Content-Type: application/json.
| Campo | Tipo | Descrição |
|---|---|---|
consentimento_confirmado obrigatório | boolean | Precisa ser true: você só cadastra quem autorizou |
contatos obrigatório | object[] | 1 a 500 itens {email, nome?} |
texto_consentimento | string | Como o consentimento foi obtido (vai para o log LGPD) |
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.
curl -X POST "https://api2.astrify.com.br/v1/email/listas/LISTA_ID/contatos" \ -H "Authorization: Bearer $ASTRIFY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "consentimento_confirmado": true, "texto_consentimento": "Marcou a caixa no checkout", "contatos": [ { "email": "ana@exemplo.com", "nome": "Ana" } ]}'const res = await fetch('https://api2.astrify.com.br/v1/email/listas/LISTA_ID/contatos', { method: 'POST', headers: { Authorization: `Bearer ${process.env.ASTRIFY_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "consentimento_confirmado": true, "texto_consentimento": "Marcou a caixa no checkout", "contatos": [ { "email": "ana@exemplo.com", "nome": "Ana" } ] }),});console.log(res.status, await res.json());import os, requests
r = requests.post( "https://api2.astrify.com.br/v1/email/listas/LISTA_ID/contatos", headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"}, json={ "consentimento_confirmado": True, "texto_consentimento": "Marcou a caixa no checkout", "contatos": [ { "email": "ana@exemplo.com", "nome": "Ana", }, ], }, timeout=20,)print(r.status_code, r.json())Resposta
Status 200, em JSON:
{ "success": true, "adicionados": 1, "suprimidos": 0, "invalidos": []}Erros
| Status | Quando acontece |
|---|---|
401 | Chave ausente, inválida, expirada ou revogada. |
403 | Sem o escopo exigido, cargo sem permissão, IP não autorizado ou registro de outra empresa. |
422 | Corpo ou parâmetro com formato inválido. O detail lista os campos com problema. |
429 | Limite 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.