Cancelar uma difusão
Para uma difusão que está `scheduled`, `queued` ou `sending`, incluindo uma que já alcançou todos enquanto algumas cópias ainda esperam para sair. Ninguém mais é adicionado, e cada cópia ainda à espera é cancelada.
Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.
POST /broadcasts/{id}/cancel
Para uma difusão que está scheduled, queued ou sending, incluindo uma que já alcançou todos enquanto algumas cópias ainda esperam para sair. Ninguém mais é adicionado, e cada cópia ainda à espera é cancelada.
Exemplo
Precisa de emails:send. Não tem corpo. A resposta é a difusão completa, encurtada aqui.
curl -X POST "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/cancel" -H "$AUTH"{ "object": "broadcast", "id": "brd_5a8c1e3f7b2d94a06c8e1f3b", "status": "cancelled", "counts": { "recipients": 412, "created": 250, "skipped": 1, "failedToQueue": 0, "queued": 0, "sending": 0, "sent": 211, "failed": 1, "cancelled": 38 }, "cancelledAt": "2026-09-23T12:00:45.000Z"}Uma cópia que já está a ser entregue termina, e as cópias que saíram não podem ser recuperadas, por isso counts.sent mantém-nas e counts.cancelled mostra o que foi parado. Cancelar antes de scheduledAt não envia rigorosamente nada.
Quando todas as cópias saíram, não resta nada para parar, e a chamada dá 409 broadcast_not_cancellable. Uma difusão failed com cópias ainda à espera pode ser cancelada para as parar, e uma sem nada à espera é recusada da mesma forma.
Cancelar uma difusão já cancelada devolve-a tal como está, por isso repetir é seguro. Não há retoma.