Plánování a rušení
Odeslat později, přesunout, nebo zastavit.
Spustí kterékoli z 2 volání na této stránce proti vašemu pracovnímu prostoru, s vaším vlastním klíčem.
Plánování
scheduledAt přijímá okamžik podle ISO-8601 nebo dobu trvání jako PT2H, až rok dopředu. Naplánovaná zpráva odpoví 202 se status: "scheduled" a zůstává zrušitelná až do chvíle, kdy odejde.
cancellableForSeconds dělá totéž pro okamžité odeslání: je to okno pro vrácení odeslání z editoru zpráv, vystavené ven místo toho, aby bylo napevno svázané s uživatelským nastavením, kterému do chování API nic není. Vzájemně se vylučují: naplánovaná zpráva je zrušitelná už tak.
Naplánování odeslání
Dvě hodiny dopředu. Odpověď nese id, které budete potřebovat k přesunu nebo zastavení.
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" }'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, ne 200: ještě se s ní musí něco stát. Okamžité odeslání odpoví 200 se status: "sent", takže volající se může větvit podle samotného stavového kódu.
Přesunutí
PATCH /emails/{id}. Změnit lze jen scheduledAt, a to jen dokud je zpráva ve frontě nebo naplánovaná.
curl -X PATCH "$OE/emails/msg_8cd0a316930b4482a8b8440b" \ -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "scheduledAt": "PT6H" }'{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "scheduled", "scheduledAt": "2026-09-01T14:20:15.881Z" }Zastavení
POST /emails/{id}/cancel.
curl -X POST "$OE/emails/msg_8cd0a316930b4482a8b8440b/cancel" -H "$AUTH"{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "cancelled" }Zrušit dvakrát není chyba. Druhé volání vrátí tutéž zrušenou zprávu, takže opakování je bezpečné.
Zrušení zprávy, která už odešla, je 409 email_not_cancellable. Odeslání vzít zpět nelze a jakákoli jiná odpověď by byla lež.