Disparar ou agendar campanha

Sem scheduledAt, refaz a revisão, materializa os destinatários, reativa a conta de envio se estiver inativa, cobra o envio do saldo e começa a enviar. Com scheduledAt no futuro, agenda; a cobrança acontece no início. Uma campanha pronta (ready, comando start) inicia por aqui, sem scheduledAt, refazendo a revisão e a verificação inteiras como no disparo de um rascunho. Impedimentos voltam em details.issues. Exige email_marketing:start. Exige o cabeçalho Idempotency-Key (400 idempotency_key_required ou idempotency_key_invalid): repetir a mesma chave com o mesmo corpo devolve a primeira resposta com Idempotent-Replayed: true sem refazer nada; enquanto a primeira ainda roda, responde 409 idempotency_in_progress (repita em instantes); com outro corpo, 422 idempotency_key_reused; sem como conferir a chave, 503 idempotency_unavailable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Campanha

Body Params

Agendamento

string
Headers
string
required

Chave gerada uma vez por pedido; repetir a mesma chave devolve a mesma resposta sem enviar nem cobrar de novo

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json