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

“ऑफ़िस से बाहर” वाला जवाब सेट करें

एक पते या कैच-ऑल का जवाब सेव करें, जो पहले से सेव किसी भी जवाब की जगह ले लेता है।

PUT/out-of-office

असली कॉल आपके वर्कस्पेस पर चलाता है।

PUT /out-of-office

एक पते या कैच-ऑल का जवाब सेव करें, जो पहले से सेव किसी भी जवाब की जगह ले लेता है।

उदाहरण

settings:write चाहिए। address क्वेरी में जाता है, और message एकमात्र ज़रूरी फ़ील्ड है: 1 से 10,000 वर्णों का सादा टेक्स्ट।

curl
curl -X PUT "$OE/[email protected]" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "startsAt": "2026-12-22T00:00:00Z",    "endsAt": "2027-01-04T08:00:00Z",    "subject": "Away until 4 January",    "message": "I am away until 4 January and will answer when I am back."  }'
प्रतिक्रिया
{  "object": "out_of_office",  "address": "[email protected]",  "enabled": true,  "active": true,  "startsAt": "2026-12-22T00:00:00.000Z",  "endsAt": "2027-01-04T08:00:00.000Z",  "subject": "Away until 4 January",  "message": "I am away until 4 January and will answer when I am back.",  "contactsOnly": false,  "updatedAt": "2026-12-22T09:14:03.117Z"}

अभी शुरू करने के लिए, या पहले से चालू जवाब की शुरुआत बनाए रखने के लिए, startsAt छोड़ दें, और जवाब को बंद किए जाने तक चालू रखने के लिए endsAt छोड़ दें या null दें। subject ज़्यादा से ज़्यादा 255 वर्ण लेता है, और खाली छोड़ने पर जवाब Re: और मिले हुए विषय के साथ जाता है। enabled: false टेक्स्ट रखता है और जवाब को रोक देता है, और contactsOnly: true सिर्फ़ संपर्कों और उन लोगों को जवाब देता है जिन्हें वर्कस्पेस ने लिखा है।

हर भेजने वाले को बाहर रहने की पूरी अवधि में जवाब एक बार मिलता है, उसी थ्रेड के भीतर, उस पते से जिस पर मेल आया था। startsAt बदलने से नई अवधि शुरू होती है जिसमें हर किसी को एक बार फिर जवाब दिया जाता है, और सिर्फ़ टेक्स्ट या endsAt बदलने से ऐसा नहीं होता। endsAt न हो तो भेजने वाले को 30 दिन बाद फिर जवाब दिया जाता है। जवाब में Auto-Submitted: auto-replied होता है, कोई ट्रैकिंग नहीं और कोई हस्ताक्षर नहीं, यह महीने के भेजे गए संदेशों में गिना जाता है, और म्यूट किए गए थ्रेड पर भी जाता है।

जिस मेल से किसी को अलर्ट नहीं जाता, उसे कोई जवाब नहीं मिलता: स्पैम, वह मेल जिसे किसी नियम ने बिन में भेजा हो, न्यूज़लेटर और बाकी बल्क मेल, स्वचालित मेल, बाउंस, ब्लॉक किए गए भेजने वाले और वर्कस्पेस के अपने पते। सबसे पहले ठीक उसी पते के लिए सेव किया गया जवाब लागू होता है, फिर बिना प्लस-टैग वाले पते का, फिर कैच-ऑल का, और कैच-ऑल कभी उस पते की ओर से जवाब नहीं देता जिसे किसी ने हाथ से बनाया हो।

422 invalid_parameter का मतलब है कि address नहीं दिया गया, वह वर्कस्पेस का पता नहीं है या पूरे डोमेन का नाम लेता है, संदेश खाली है, या endsAt startsAt के बाद नहीं है या पहले ही बीत चुका है। कुछ भी टाइमर पर नहीं चलता: तारीख़ें मेल आने पर जाँची जाती हैं।

संदर्भ