Отменить рассылку
Останавливает рассылку в состоянии `scheduled`, `queued` или `sending`, включая ту, что уже достигла всех, пока часть копий ещё ждёт отправки. Больше никто не добавляется, и каждая ещё ждущая копия отменяется.
Выполняет настоящий запрос в вашем рабочем пространстве, с вашим собственным ключом.
POST /broadcasts/{id}/cancel
Останавливает рассылку в состоянии scheduled, queued или sending, включая ту, что уже достигла всех, пока часть копий ещё ждёт отправки. Больше никто не добавляется, и каждая ещё ждущая копия отменяется.
Пример
Требует emails:send. Тела нет. Ответ — вся рассылка, здесь в сокращённом виде.
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"}Копия, которая уже передаётся, доходит до конца, а ушедшие копии вернуть нельзя, поэтому counts.sent их сохраняет, а counts.cancelled показывает, что было остановлено. Отмена до scheduledAt не отправляет вообще ничего.
Когда все копии ушли, останавливать уже нечего, и вызов даёт 409 broadcast_not_cancellable. Рассылку failed, у которой ещё ждут копии, можно отменить, чтобы остановить их, а рассылка, у которой ничего не ждёт, отклоняется так же.
Отмена уже отменённой рассылки возвращает её как есть, поэтому повтор безопасен. Возобновления нет.