Kalo te dokumentacioni
API

Planifikimi dhe anulimi

Dërgojeni më vonë, zhvendoseni ose ndaleni.

PATCHapi.openemail.uk/emails/{id}

Ekzekuton cilëndo nga 2 thirrjet e kësaj faqeje kundrejt hapësirës suaj të punës, me çelësin tuaj.

Planifikimi

scheduledAt merr një çast ISO-8601 ose një kohëzgjatje si PT2H, deri në një vit larg. Një mesazh i planifikuar përgjigjet me 202 dhe status: "scheduled" dhe mbetet i anulueshëm deri në çastin që niset.

cancellableForSeconds bën të njëjtën gjë për një dërgim të menjëhershëm: dritarja e zhbërjes së dërgimit në kompozues, e ekspozuar në vend që të lidhet fort pas një cilësimi përdoruesi që s’ka pse të vendosë për sjelljen e një API-je. Të dyja përjashtojnë njëra-tjetrën: një mesazh i planifikuar është tashmë i anulueshëm.

Planifikoni një dërgim

Dy orë më vonë. Përgjigjja mbart id-në që do t’ju duhet për ta zhvendosur ose ndalur.

curl
curl -X POST "$OE/emails" -H "$AUTH" -H "Content-Type: application/json" \    -d '{      "from": "[email protected]",      "to": ["[email protected]"],      "subject": "Your September invoice",      "html": "<p>Invoice attached.</p>",      "scheduledAt": "PT2H"    }'
Përgjigje
HTTP/1.1 202 Accepted  Location: /emails/msg_8cd0a316930b4482a8b8440b   {    "object": "email",    "id": "msg_8cd0a316930b4482a8b8440b",    "status": "scheduled",    "scheduledAt": "2026-09-01T10:19:41.345Z",    "cancellableUntil": "2026-09-01T10:19:41.345Z",    "messageId": null,    "transport": null,    "sentAt": null  }

202, jo 200: diçka duhet të ndodhë ende me të. Një dërgim i menjëhershëm përgjigjet me 200 dhe status: "sent", që një thirrës të mund të degëzojë vetëm sipas kodit të statusit.

Zhvendoseni

PATCH /emails/{id}. Vetëm scheduledAt mund të ndryshojë, dhe vetëm derisa mesazhi është në radhë ose i planifikuar.

curl
curl -X PATCH "$OE/emails/msg_8cd0a316930b4482a8b8440b" \    -H "$AUTH" -H "Content-Type: application/json" \    -d '{ "scheduledAt": "PT6H" }'
Përgjigje
{    "object": "email",    "id": "msg_8cd0a316930b4482a8b8440b",    "status": "scheduled",    "scheduledAt": "2026-09-01T14:20:15.881Z"  }

Ndaleni

POST /emails/{id}/cancel.

curl
curl -X POST "$OE/emails/msg_8cd0a316930b4482a8b8440b/cancel" -H "$AUTH"
Përgjigje
{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "cancelled" }

Anulimi dy herë nuk është gabim. Thirrja e dytë kthen të njëjtin mesazh të anuluar, ndaj një riprovim është i sigurt.

Anulimi i një mesazhi që ka ikur tashmë është një 409 email_not_cancellable. Ai nuk mund të ç’dërgohet, dhe çdo përgjigje tjetër do të ishte gënjeshtër.