Plannen en annuleren
Later versturen, verplaatsen of stoppen.
Voert elk van de 2 aanroepen op deze pagina uit op je workspace, met je eigen sleutel.
Plannen
scheduledAt neemt een ISO-8601-tijdstip of een duur als PT2H, tot een jaar vooruit. Een gepland bericht antwoordt met 202 en status: "scheduled" en blijft annuleerbaar tot het moment van verzenden.
cancellableForSeconds doet hetzelfde voor een directe verzending: het venster uit de composer om verzenden ongedaan te maken, hier blootgelegd in plaats van vastgeknoopt aan een gebruikersinstelling die niets te zeggen heeft over het gedrag van een API. De twee sluiten elkaar uit: een gepland bericht is al annuleerbaar.
Een verzending plannen
Twee uur vooruit. Het antwoord bevat de id die je nodig hebt om het te verplaatsen of te stoppen.
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, niet 200: er moet er nog iets mee gebeuren. Een directe verzending antwoordt met 200 en status: "sent", zodat een aanroeper alleen al op de statuscode kan vertakken.
Verplaatsen
PATCH /emails/{id}. Alleen scheduledAt kan wijzigen, en alleen zolang het in de wachtrij staat of gepland is.
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" }Stoppen
POST /emails/{id}/cancel.
curl -X POST "$OE/emails/msg_8cd0a316930b4482a8b8440b/cancel" -H "$AUTH"{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "cancelled" }Twee keer annuleren is geen fout. De tweede aanroep geeft hetzelfde geannuleerde bericht terug, dus opnieuw proberen is veilig.
Een bericht annuleren dat al weg is levert een 409 email_not_cancellable op. Het kan niet onverzonden worden gemaakt, en iets anders antwoorden zou een leugen zijn.