POST /api/v1/mail/campaigns/compose. As rotas privadas aceitam x-api-key ou Authorization: Bearer <token>.{
"name": "Novidades de outubro",
"from": "novidades@empresa.com.br",
"fromName": "Equipe da Empresa",
"listId": "ID_DA_LISTA",
"subject": "O que há de novo",
"html": "<h1>Novidades</h1><p>Confira as atualizações.</p>",
"text": "Novidades: confira as atualizações.",
"mode": "draft"
}"mode":"send". Para agendar, use também "scheduledAt":"2026-11-01T13:00:00.000Z"; a data deve estar no futuro e incluir fuso horário. O contrato público da API v1 para campanhas aceita conteúdo em texto e HTML e, em multipart/form-data, anexos no campo attachments (até 10 arquivos de 10 MiB).html e text. Repetir a publicação de um rascunho que já foi publicado não cria outra campanha.POST /api/v1/mail/campaigns/test usa os mesmos campos de mensagem e exige to com o endereço que receberá o teste. O envio de teste não é o envio da campanha para a lista.| Rota | Uso |
|---|---|
GET /api/v1/lists/campaigns | Campanhas da conta; opcionalmente filtre por listId. |
GET /api/v1/lists/campaigns/drafts/{draftId} | Carregar um rascunho para continuar editando. |
GET /api/v1/lists/{listId}/campaign-audience | Consultar total da lista, elegíveis e excluídos. |
GET /api/v1/lists/{listId}/campaigns/{campaignId} | Detalhes e métricas da campanha. |
GET /api/v1/lists/{listId}/campaigns/{campaignId}/messages | Consultar destinatários; aceita busca q e filtro status. |
pending, submitting, submitted, failed, skipped e unknown. submitted significa que o servidor SMTP aceitou a mensagem para envio; não confirma que ela chegou à caixa de entrada. unknown indica resultado que não pôde ser confirmado com segurança, e não deve ser interpretado como sucesso ou reenviado automaticamente.| Evento | Quando acontece |
|---|---|
campaign.created | Uma campanha nova ou rascunho é criado. |
campaign.queued | A campanha é publicada, inclusive quando agendada. |
campaign.started | O primeiro destinatário começa a ser processado. |
campaign.completed | O processamento termina sem falhas confirmadas ou resultados a confirmar. |
campaign.failed | O processamento termina com falhas ou resultados a confirmar. |
smtp.email.accepted | Um destinatário é aceito para envio. |