mail

POST /v1/mail/services/{mailServiceId}/responders

Set an auto-reply on a mailbox.

כל נקודות הקצה מסוג mail

אימות

שלחו מפתח 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).

גוף הבקשה

שםסוגנדרשמה זה
localstringכןThe mailbox to auto-reply for.
subjectstringלא
contentstringכן
start_timestringלאRFC 3339. Omit or `null` for no schedule - see `MailResponder`.
end_timestringלאRFC 3339, and must be after `start_time` when both are given.

תשובה

שםסוגנדרשמה זה
idstringכןThe mail backend's identifier - the handle `DELETE` needs.
localstringכןThe part before the `@`.
addressstringכןThe mailbox this replies for.
subjectstringכן
contentstringכןThe reply body.
start_timestringכן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_timestringכןWhen the auto-reply stops. `null` to run until switched off.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429 · 503