Belgelere geç
API

Bir toplu gönderimi iptal et

`scheduled`, `queued` ya da `sending` olan bir toplu gönderimi durdurur; bazı kopyalar hâlâ gitmeyi beklerken herkese ulaşmış olanlar da buna dahildir. Kimse eklenmez ve hâlâ bekleyen her kopya iptal edilir.

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

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

POST /broadcasts/{id}/cancel

scheduled, queued ya da sending olan bir toplu gönderimi durdurur; bazı kopyalar hâlâ gitmeyi beklerken herkese ulaşmış olanlar da buna dahildir. Kimse eklenmez ve hâlâ bekleyen her kopya iptal edilir.

Örnek

emails:send gerekir. Gövde yoktur. Yanıt toplu gönderimin tamamıdır, burada kısaltılmıştır.

curl
curl -X POST "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/cancel" -H "$AUTH"
Yanıt
{  "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"}

Zaten teslim edilmekte olan bir kopya tamamlanır ve gitmiş kopyalar geri alınamaz; bu yüzden counts.sent onları tutar, counts.cancelled ise durdurulanı gösterir. scheduledAt'ten önce iptal etmek hiçbir şey göndermez.

Her kopya gittikten sonra durdurulacak bir şey kalmaz ve çağrı 409 broadcast_not_cancellable olur. Hâlâ bekleyen kopyaları olan failed bir toplu gönderim bunları durdurmak için iptal edilebilir, bekleyen hiçbir şeyi olmayan ise aynı biçimde reddedilir.

Zaten iptal edilmiş bir toplu gönderimi iptal etmek onu olduğu gibi döndürür, bu yüzden yeniden denemek güvenlidir. Devam ettirme yoktur.