mail

PATCH `/v1/mail/services/{mailServiceId}/responders/{responderId}`

Edit an auto-reply.

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 PATCH https://api.zinndigital.com/v1/mail/services/{mailServiceId}/responders/{responderId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "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

Changes the message and its schedule. **The address is not part of this body** — an auto-reply belongs to a mailbox, and the address is *which mailbox you are editing* rather than a property of the reply. ⭐ This used to say *"the mail backend has no rename verb"*. That was **false** and was the stated premise of a decision to offer no rename at all; measured against the live upstream hosting API on 2026-08-16, a mailbox renames **in place**, same id, contents intact. Use `renameMailbox` to change an address, or a forwarder to give a mailbox a second one. The responder is returned **as the backend reports it back after the write**, not as it was sent: the mail backend answers an applied update and an ignored one with the same empty body, so echoing the request would be a fabricated success (D9256). Requires `mail.manage`.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`mailServiceId (path)`	`Uuid`	Sì	Email service ID (UUIDv7).
`responderId (path)`	`string`	Sì	The mail backend's identifier for the responder, as returned by the list — not a UUID of ours. A responder has no model here, so there is no id of ours to use.

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`subject`	`string`	No	—
`content`	`string`	Sì	—
`start_time`	`string`	No	RFC 3339. `null` clears the schedule.
`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

PATCH /v1/mail/services/{mailServiceId}/responders/{responderId}