문서로 건너뛰기
API

브로드캐스트 취소

`scheduled`, `queued`, `sending` 상태인 브로드캐스트를 멈춥니다. 모두에게 닿았지만 일부 사본이 아직 나가기를 기다리는 것도 포함됩니다. 더 이상 아무도 추가되지 않고, 아직 기다리는 모든 사본이 취소됩니다.

POSTapi.openemail.uk/broadcasts/{id}/cancel

본인 키로 워크스페이스에 실제 호출을 실행합니다.

POST /broadcasts/{id}/cancel

scheduled, queued, sending 상태인 브로드캐스트를 멈춥니다. 모두에게 닿았지만 일부 사본이 아직 나가기를 기다리는 것도 포함됩니다. 더 이상 아무도 추가되지 않고, 아직 기다리는 모든 사본이 취소됩니다.

예시

emails:send가 필요합니다. 본문은 없습니다. 응답은 브로드캐스트 전체이며, 여기서는 줄였습니다.

curl
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 브로드캐스트는 취소해서 멈출 수 있고, 대기 중인 것이 없으면 같은 방식으로 거절됩니다.

이미 취소된 브로드캐스트를 취소하면 현재 상태 그대로 돌려주므로 재시도는 안전합니다. 재개는 없습니다.