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 の一斉配信はキャンセルしてそれらを止められ、待機中のものが何もない場合は同じように拒否されます。

すでにキャンセルされた一斉配信をキャンセルすると、その時点の状態で返るので、再試行は安全です。再開はできません。