दस्तावेज़ पर जाएँ
API

broadcast रद्द करें

उस broadcast को रोकता है जो `scheduled`, `queued` या `sending` है, जिसमें वह भी शामिल है जो सब तक पहुँच चुका है जबकि कुछ कॉपियाँ अब भी जाने का इंतज़ार कर रही हैं। कोई और नहीं जोड़ा जाता, और इंतज़ार कर रही हर कॉपी रद्द होती है।

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

असली कॉल आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।

POST /broadcasts/{id}/cancel

उस broadcast को रोकता है जो scheduled, queued या sending है, जिसमें वह भी शामिल है जो सब तक पहुँच चुका है जबकि कुछ कॉपियाँ अब भी जाने का इंतज़ार कर रही हैं। कोई और नहीं जोड़ा जाता, और इंतज़ार कर रही हर कॉपी रद्द होती है।

उदाहरण

emails:send चाहिए। कोई मुख्य भाग नहीं। जवाब पूरा broadcast है, यहाँ छोटा करके दिखाया गया।

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 broadcast की कॉपियाँ अभी इंतज़ार में हों उसे रद्द करके उन्हें रोका जा सकता है, और जिसके पास इंतज़ार में कुछ न हो वह इसी तरह मना होता है।

पहले से रद्द broadcast को रद्द करना उसे जैसा है वैसा लौटाता है, इसलिए दोबारा कोशिश सुरक्षित है। फिर से शुरू करने का कोई तरीका नहीं।