Developers
Criar chave de APIEntrar na plataforma

Enviar e-mail transacional

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/enviar

Escopo: email:write · Área: E-mail · Testar no navegador

E-mail transacional (1 destinatário): para, assunto, html e/ou texto; opcionais nome, responder_para, nome_remetente, instancia_id.

Para e-mail transacional (1 pessoa). Quem está na lista de supressão (bounce/spam) é recusado.

Corpo

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

CampoTipoDescrição
para obrigatóriostringDestinatário (1 por chamada)
assunto obrigatóriostring—
html stringCorpo HTML (html e/ou texto)
texto stringCorpo texto
nome stringNome do destinatário
responder_para stringReply-To
nome_remetente string—
instancia_id uuidInstância de e-mail (padrão: a principal)

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/email/enviar" \
-H "Authorization: Bearer $ASTRIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"para": "ana@exemplo.com",
"assunto": "Seu pedido foi enviado",
"html": "<p>Olá, Ana!</p>"
}'
const res = await fetch('https://api2.astrify.com.br/v1/email/enviar', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.ASTRIFY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"para": "ana@exemplo.com",
"assunto": "Seu pedido foi enviado",
"html": "<p>Olá, Ana!</p>"
}),
});
console.log(res.status, await res.json());
import os, requests
r = requests.post(
"https://api2.astrify.com.br/v1/email/enviar",
headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"},
json={
"para": "ana@exemplo.com",
"assunto": "Seu pedido foi enviado",
"html": "<p>Olá, Ana!</p>",
},
timeout=20,
)
print(r.status_code, r.json())

Resposta

Status 200, em JSON:

{
"data": {
"id": "3f9c2b1e-8a4d-4c71-9e0b-5d2a7c6f1b34",
"status": "enviado"
}
}

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.