POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione mail.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
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> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
mailServiceId (path) | Uuid | Sì | Email service ID (UUIDv7). |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
local | string | Sì | The mailbox to auto-reply for. |
subject | string | No | — |
content | string | Sì | — |
start_time | string | No | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | No | RFC 3339, and must be after `start_time` when both are given. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | string | Sì | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Sì | The part before the `@`. |
address | string | Sì | The mailbox this replies for. |
subject | string | Sì | — |
content | string | Sì | The reply body. |
start_time | string | Sì | 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 | Sì | When the auto-reply stops. `null` to run until switched off. |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422 · 429 · 503