Envio de emails

Envie emails do seu domínio pelo seu sistema, com a entrega da Nevox.

Seu sistema envia emails (confirmação de pedido, recibo, aviso) do seu domínio pela Nevox. Você cuida do texto; a Nevox cuida da entrega, dos bounces e de quem pediu para não receber.

O envio de emails é liberado por conta pela equipe Nevox. Antes do primeiro envio:

Peça à equipe para ligar o envio de emails na sua conta.
A equipe cadastra o seu domínio e passa os registros de DNS para você criar (todos apontam para a Nevox).
Com o domínio verificado, gere uma chave com o escopo emails:send (e emails:read para consultar) em Painel → Desenvolvedores. Chaves geradas antes disso não têm esses escopos.

Enviar

POST /v1/emails · escopo emails:send

bash

curl -X POST https://api.nevox.ai/v1/emails \
  -H "Authorization: Bearer $NEVOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "pedidos@sualoja.com.br",
    "from_name": "Sua Loja",
    "to": ["maria@exemplo.com"],
    "subject": "Seu pedido saiu para entrega",
    "text": "Olá, Maria! Seu pedido 1042 saiu para entrega.",
    "html": "<p>Olá, Maria! Seu pedido <b>1042</b> saiu para entrega.</p>",
    "reply_to": "atendimento@sualoja.com.br"
  }'

Campo	Obrigatório	O que é
`from`	sim	Remetente, de um domínio verificado da sua conta
`from_name`	não	Nome que aparece para quem recebe
`to`	sim	Um email ou uma lista de até 50. Cada destinatário recebe um email só dele
`subject`	sim	Assunto, até 300 caracteres
`text`	sim, se não tiver `html`	Versão em texto
`html`	não	Versão em HTML
`reply_to`	não	Para onde vão as respostas

Resposta: um item por destinatário.

json

{
  "data": [
    { "object": "email", "id": "eml_4f1c9a", "to": "maria@exemplo.com", "status": "sent", "error_code": null }
  ]
}

status é sent (entregue à Nevox para envio), suppressed (o endereço não recebe mais da sua conta: bounce, denúncia ou descadastro) ou failed, com o motivo em error_code:

Código	O que fazer
`domain_not_verified`	O `from` não é de um domínio verificado da sua conta
`recipient_suppressed`	O endereço não recebe mais; tire da sua lista
`invalid_message`	Confira o conteúdo e os endereços
`rate_limited`	Envie de novo em alguns minutos
`service_unavailable` / `send_failed`	Falha na entrega; tente de novo mais tarde

Com a chave de teste, a Nevox confere tudo e não envia nada (status: "test").

Sem o envio de emails liberado na conta, a resposta é 403 com o código module_required.

Consultar um email

GET /v1/emails/{id} · escopo emails:read

bash

curl https://api.nevox.ai/v1/emails/eml_4f1c9a \
  -H "Authorization: Bearer $NEVOX_API_KEY"

Devolve from, to, subject, status (inclusive delivered, bounced e complained, quando chegam), error_code, opened_at, clicked_at, created_at e updated_at. O conteúdo do email não fica guardado.