POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास mail.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/responders \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "local": <string>, "content": <string> }'साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
विवरण
Idempotent on local: re-posting for the same mailbox reconciles to the existing responder rather than creating a second one, which is the backend's own natural key. Requires mail.manage.
पैरामीटर
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
mailServiceId (path) | Uuid | हाँ | Email service ID (UUIDv7). |
अनुरोध बॉडी
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
local | string | हाँ | The mailbox to auto-reply for. |
subject | string | नहीं | — |
content | string | हाँ | — |
start_time | string | नहीं | RFC 3339. Omit or null for no schedule - see MailResponder. |
end_time | string | नहीं | RFC 3339, and must be after start_time when both are given. |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
id | string | हाँ | The mail backend's identifier - the handle DELETE needs. |
local | string | हाँ | The part before the @. |
address | string | हाँ | The mailbox this replies for. |
subject | string | हाँ | — |
content | string | हाँ | The reply body. |
start_time | string | हाँ | When the auto-reply starts. null when unscheduled (it replies from now on). ⭐ This used to be declared "Opaque - do not parse, compare or render as a date" (#664), out of a… |
end_time | string | हाँ | When the auto-reply stops. null to run until switched off. |
त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है
401 · 403 · 404 · 422 · 429 · 503