Referência da API

Enviar e-mail

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

Visão geral

Endpointhttps://api.unbox.im/v1/email
MétodoPOST
Content-Typeapplication/json
EscopoUma chave de API por domínio personalizado

Gere chaves em Conta → Domínios → seu domínio → API após a verificação de DNS ser concluída. O segredo completo é exibido uma vez — armazene-o com segurança. Credenciais SMTP opcionais no mesmo painel de Domínios seguem as mesmas regras de apenas transacionais.

Apenas e-mails transacionais

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

Usos permitidos

  • Verificação de conta, redefinição de senha e alertas de segurança
  • Confirmações de pedido, recibos, atualizações de envio e avisos de pagamento
  • Notificações acionadas por um evento específico de usuário ou sistema
  • Mensagens de equipe e espaço de trabalho (convites, atribuições, alertas internos)

Usos proibidos

  • Newsletters, campanhas promocionais ou marketing em massa
  • Abordagem a frio ou envio para listas compradas, raspadas ou sem consentimento
  • Spam de afiliados, phishing ou conteúdo enganoso
  • Qualquer tentativa de contornar limites de destinatários, taxas ou cotas do plano

Limites de taxa e destinatários

Para proteger destinatários e a entregabilidade, o tráfego de saída da API e SMTP está sujeito aos limites abaixo (além da cota mensal de saída do seu plano). A aplicação é ativa no compositor web, na API HTTP e no envio SMTP. O compositor web alerta após 25 destinatários por mensagem e bloqueia envios acima de 50.

LimiteValor
Destinatários por mensagemAté 50 no total (Para + Cc + Cco combinados)
Destinatários únicos por diaAté 1.000 por espaço de trabalho
Taxa de solicitação de envioAté 10 envios por API ou SMTP por minuto por domínio
Cota de saída do planoOs limites mensais de envio da sua assinatura ainda se aplicam

Estas regras fazem parte da nossa Política de Uso Aceitável. A aplicação automatizada está ativa no compositor web, na API HTTP e no envio SMTP. Contas que enviem e-mails de marketing ou em massa, ou que abusem da infraestrutura de envio, podem ser limitadas, suspensas ou encerradas.

Monitoramos sinais de entregabilidade. Taxas de rejeição sustentadas acima de 3% ou taxas de reclamação acima de 0,1% podem acionar uma pausa temporária de envio ou revisão manual.

Consulte nossos Termos de Serviço, Política de Privacidade e Declaração GDPR para detalhes completos da política.

Autenticação

Envie sua chave de API do domínio em cada requisição:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Alternativamente, use X-Api-Key: ubk_live_…. As chaves são armazenadas de forma hash; revogue ou altere pelo painel de Domínios.

Corpo da requisição

JSON com nomes de campos em PascalCase (From, To, …). Aliases em camelCase também são aceitos.

CampoObrigatórioDescrição
FromSimRemetente — sua caixa de correio pessoal no domínio da chave (principal ou alias). Filas compartilhadas não são remetentes válidos.
ToSimDestinatário(s) — string, string separada por vírgulas ou array
SubjectSimLinha de assunto
TextBodyUm de TextBody / HtmlBodyCorpo em texto simples
HtmlBodyUm de TextBody / HtmlBodyCorpo em HTML
CcNãoDestinatários em cópia
BccNãoDestinatários em cópia oculta
ReplyToNãoEndereço de resposta (Reply-To)
TagNãoTag opcional de metadados (armazenada com o envio)

Exemplo

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

Resposta de sucesso

HTTP 200 com JSON:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

Respostas de erro

Erros retornam 4xx (ou 500 para falhas inesperadas) com JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
Código de erroSignificado
0Sucesso
10Chave de API ausente
11Chave inválida ou revogada, ou domínio não verificado para envio
300Erro de validação (campos ausentes, JSON inválido, etc.)
403Endereço de remetente não permitido — deve ser sua caixa postal pessoal no domínio da chave
406SES rejeitou a mensagem

Exemplos

Substitua you@yourdomain.com pela sua caixa postal pessoal no domínio e use sua própria chave de API.

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

Primeiros passos

  1. Crie uma conta Unbox e adicione seu domínio personalizado.
  2. Conclua todas as etapas de verificação de DNS em Domínios.
  3. Acesse Domínios → seu domínio → API e gere uma chave de domínio.
  4. Envie sua primeira mensagem com os exemplos acima.
Unbox — Documentação da API | Unbox.im