Programar i cancel·lar
Envieu-lo més tard, moveu-lo o atureu-lo.
Executa qualsevol de les 2 crides d'aquesta pàgina contra el teu espai de treball, amb la teva pròpia clau.
Programació
scheduledAt accepta un instant ISO-8601 o una durada com ara PT2H, fins a un any vista. Un missatge programat respon 202 amb status: "scheduled" i es pot cancel·lar fins al moment mateix en què s'envia.
cancellableForSeconds fa el mateix per a un enviament immediat: la finestra per desfer l'enviament del redactor, exposada en lloc de lligada a una preferència d'usuari que no té cap motiu per decidir el comportament d'una API. Els dos són mútuament excloents: un missatge programat ja es pot cancel·lar.
Programar un enviament
D'aquí a dues hores. La resposta porta l'id que necessitareu per moure'l o aturar-lo.
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, no 200: encara li ha de passar alguna cosa. Un enviament immediat respon 200 amb status: "sent", de manera que qui crida pot ramificar només segons el codi d'estat.
Moure'l
PATCH /emails/{id}. Només es pot canviar scheduledAt, i només mentre estigui en cua o programat.
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" }Aturar-lo
POST /emails/{id}/cancel.
curl -X POST "$OE/emails/msg_8cd0a316930b4482a8b8440b/cancel" -H "$AUTH"{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "cancelled" }Cancel·lar dues vegades no és cap error. La segona crida retorna el mateix missatge cancel·lat, de manera que reintentar-ho és segur.
Cancel·lar-ne un que ja ha sortit és un 409 email_not_cancellable. No es pot desenviar, i respondre qualsevol altra cosa seria mentida.