POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
mailServiceId (path) | Uuid | Igen | Email service ID (UUIDv7). |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
local | string | Igen | The mailbox to auto-reply for. |
subject | string | Nem | — |
content | string | Igen | — |
start_time | string | Nem | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Nem | RFC 3339, and must be after `start_time` when both are given. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | string | Igen | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Igen | The part before the `@`. |
address | string | Igen | The mailbox this replies for. |
subject | string | Igen | — |
content | string | Igen | The reply body. |
start_time | string | Igen | 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 | Igen | When the auto-reply stops. `null` to run until switched off. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422 · 429 · 503