API

Anulo një transmetim

Ndal një transmetim që është `scheduled`, `queued` ose `sending`, përfshirë një që i ka arritur të gjithë ndërsa disa kopje ende presin të dalin. Nuk shtohet askush tjetër, dhe çdo kopje që pret ende anulohet.

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

Ekzekuton thirrjen reale kundrejt hapësirës suaj të punës, me çelësin tuaj.

POST /broadcasts/{id}/cancel

Ndal një transmetim që është scheduled, queued ose sending, përfshirë një që i ka arritur të gjithë ndërsa disa kopje ende presin të dalin. Nuk shtohet askush tjetër, dhe çdo kopje që pret ende anulohet.

Shembull

Kërkon emails:send. Nuk ka trup. Përgjigja është i gjithë transmetimi, i shkurtuar këtu.

curl

curl -X POST "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/cancel" -H "$AUTH"

Përgjigje

{  "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"}

Një kopje që po dorëzohet përfundon, dhe kopjet që kanë dalë nuk mund të tërhiqen, ndaj counts.sent i mban ato dhe counts.cancelled tregon çfarë u ndal. Anulimi para scheduledAt nuk dërgon asgjë fare.

Pasi ka dalë çdo kopje nuk mbetet asgjë për të ndalur, dhe thirrja është 409 broadcast_not_cancellable. Një transmetim failed me kopje që ende presin mund të anulohet për t’i ndalur, dhe një pa asgjë në pritje refuzohet në të njëjtën mënyrë.

Anulimi i një transmetimi tashmë të anuluar e kthen ashtu siç është, ndaj riprovimi është i sigurt. Nuk ka rinisje.