Skip to main content

​
Por que este canal importa

E-mail é o padrão para recibo, redefinição de senha, confirmação de pedido e comunicação longa. Na Notifique você mantém um contrato HTTP estável (POST /v1/email/messages), enquanto a plataforma cuida de fila, provedor, reputação básica e status — sem você montar SMTP e monitoramento do zero.

​
O que você encontra no painel

  • Domínios — cadastro e verificação por DNS (registros que o painel mostra para você colar no provedor do domínio).
  • Remetente padrão — definir de qual endereço @seu-dominio os envios partem quando a API não manda from explícito.
  • API Keys e escopos — separar quem só envia de quem gerencia domínios ou lê status de mensagens.
  • Webhooks — receber eventos de entrega, falha, abertura, clique ou reclamação de spam, conforme a configuração do workspace.

​
O que você encontra na API

  • Envio — POST /v1/email/messages com to (1 a 100 endereços), subject e corpo em texto, HTML ou os dois.
  • Agendamento — schedule.sendAt em ISO 8601; resposta pode trazer status: "SCHEDULED" e scheduledAt.
  • Cancelamento — só enquanto o status for SCHEDULED; depois de enfileirado ou enviado, não há como cancelar pela API.
  • Domínios — POST /v1/email/domains, leitura de registros DNS e POST .../verify até o status ficar VERIFIED — obrigatório para usar o domínio no from.
  • Idempotência — Idempotency-Key / x-idempotency-key no envio para evitar e-mails duplicados em retries.
Sem domínio verificado, o envio retorna erro de negócio (400, código DOMAIN_NOT_VERIFIED). O fluxo passo a passo continua valendo: registrar → configurar DNS → verificar → enviar.

​
Regras e status em resumo

  • Cobrança — cada e-mail costuma consumir 1 crédito (plano) ou saldo em Pague pelo uso; quem está em plano e esgota o mês pode usar saldo automaticamente.
  • Prioridade — options.priority: high, normal ou low (padrão normal).
  • Limite de domínios — depende do plano; domínio duplicado retorna 409.
Status da mensagem (principais): SCHEDULED → QUEUED → SENT → DELIVERED; também OPENED, CLICKED, FAILED, COMPLAINED, CANCELLED. Status do domínio: PENDING → VERIFIED ou FAILED.
Para verificar um domínio (POST /v1/email/domains/{id}/verify) você precisa de escopos como email:domains:list ou email:domains:create, conforme a operação.

​
Próximos passos