POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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`.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
mailServiceId (path) | Uuid | Ano | Email service ID (UUIDv7). |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
local | string | Ano | The mailbox to auto-reply for. |
subject | string | Ne | — |
content | string | Ano | — |
start_time | string | Ne | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Ne | RFC 3339, and must be after `start_time` when both are given. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Ano | The part before the `@`. |
address | string | Ano | The mailbox this replies for. |
subject | string | Ano | — |
content | string | Ano | The reply body. |
start_time | string | Ano | 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 | Ano | When the auto-reply stops. `null` to run until switched off. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429 · 503