mail

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

Edit an auto-reply.

Tous les points de terminaison mail

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation mail.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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`.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
mailServiceId (path)UuidOuiEmail service ID (UUIDv7).
responderId (path)stringOuiThe **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.

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
subjectstringNon
contentstringOui
start_timestringNonRFC 3339. `null` clears the schedule.
end_timestringNonRFC 3339, and must be after `start_time` when both are given.

Réponse

NomTypeObligatoireQu'est-ce que c'est
idstringOuiThe mail backend's identifier - the handle `DELETE` needs.
localstringOuiThe part before the `@`.
addressstringOuiThe mailbox this replies for.
subjectstringOui
contentstringOuiThe reply body.
start_timestringOuiWhen 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_timestringOuiWhen the auto-reply stops. `null` to run until switched off.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429 · 503