POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
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 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> }'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
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ètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
mailServiceId (path) | Uuid | Oui | Email service ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
local | string | Oui | The mailbox to auto-reply for. |
subject | string | Non | — |
content | string | Oui | — |
start_time | string | Non | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Non | RFC 3339, and must be after `start_time` when both are given. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Oui | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Oui | The part before the `@`. |
address | string | Oui | The mailbox this replies for. |
subject | string | Oui | — |
content | string | Oui | The reply body. |
start_time | string | Oui | 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 | Oui | When the auto-reply stops. `null` to run until switched off. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429 · 503