दस्तावेज़ पर जाएँ
API

शेड्यूल और रद्द करना

बाद में भेजें, समय बदलें, या रोक दें।

PATCHapi.openemail.uk/emails/{id}

इस पेज की 2 कॉल में से कोई भी आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।

शेड्यूलिंग

scheduledAt एक ISO-8601 क्षण या PT2H जैसी अवधि लेता है, अधिकतम एक साल आगे तक। शेड्यूल किया गया संदेश status: "scheduled" के साथ 202 देता है और भेजे जाने तक रद्द किया जा सकता है।

cancellableForSeconds तत्काल भेजाव के लिए वही काम करता है: composer की undo-send विंडो, जिसे किसी उपयोगकर्ता सेटिंग में छिपाने के बजाय उजागर किया गया है — उस सेटिंग का किसी API के व्यवहार पर कोई अधिकार नहीं होना चाहिए। दोनों परस्पर अनन्य हैं: शेड्यूल किया गया संदेश पहले से ही रद्द किया जा सकता है।

भेजाव शेड्यूल करें

दो घंटे आगे। प्रतिक्रिया में वह id होती है जो इसे खिसकाने या रोकने के लिए चाहिए होगी।

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"    }'
प्रतिक्रिया
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, 200 नहीं: इसके साथ कुछ होना अभी बाकी है। तत्काल भेजाव status: "sent" के साथ 200 देता है, इसलिए कॉलर केवल स्टेटस कोड पर शाखा बना सकता है।

समय बदलें

PATCH /emails/{id}। केवल scheduledAt बदल सकता है, और केवल तब जब वह queued या scheduled हो।

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

रोक दें

POST /emails/{id}/cancel

curl
curl -X POST "$OE/emails/msg_8cd0a316930b4482a8b8440b/cancel" -H "$AUTH"
प्रतिक्रिया
{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "cancelled" }

दो बार रद्द करना त्रुटि नहीं है। दूसरी कॉल वही रद्द किया गया संदेश लौटाती है, इसलिए पुनः प्रयास सुरक्षित है।

जो पहले ही जा चुका है उसे रद्द करने पर 409 email_not_cancellable मिलता है। उसे अन-सेंड नहीं किया जा सकता, और कुछ और उत्तर देना झूठ होता।