POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה mail.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
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… |
end_time | string | כן | When the auto-reply stops. `null` to run until switched off. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429 · 503