لغو یک ارسال گروهی
ارسال گروهیای را که `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 که هنوز نسخههایی در انتظار دارد را میتوان لغو کرد تا متوقف شوند، و آنکه چیزی در انتظار ندارد همینطور رد میشود.
لغو یک ارسال گروهیِ از پیش لغوشده آن را همانطور که هست برمیگرداند، پس تکرار امن است. ادامه دادن وجود ندارد.