PATCH /v1/mail/routing/{fqdn}
Re-point a forwarding domain's catch-all.
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/routing/{fqdn} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "destination": <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
Sets where everything addressed to this domain is delivered. Requires mail.manage. ⛔ Taking ownership is part of the write. The alias stops being system-managed, so the convergence sweep will never reassert our computed destination over the customer's choice — silently, which is the only way that failure would ever be noticed. ⛔ Refused with 422 on a domain that stores its mail in mailboxes, rather than accepted and ignored: a forwarding address on a mailbox domain is a control that appears to work while mail keeps arriving in the mailbox.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
fqdn (path) | string | Oui | The hostname whose mail routing is being read or changed. |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
destination | string | Oui | Where mail to any address on this domain is delivered. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
fqdn | string | Oui | The domain this routing is for. |
mechanism | string<zinn_mailbox, zinn_forward, cloudflare_routing, external, none> | Oui | Which mechanism serves this domain's inbound mail. zinn_mailbox stores it; zinn_forward and cloudflare_routing pass it on and store nothing; external means the customer's… |
mechanism_label | string | Oui | Why this mechanism was chosen, in a sentence a person can act on. |
forwards | boolean | Oui | Whether mail is passed on rather than stored. |
stores | boolean | Oui | Whether this domain has real mailboxes on our relay. |
status | string<pending, converged, held, failed> | Oui | The last convergence pass's outcome. held is distinct from failed and means the zone could not be read, so nothing was changed — which is correct behaviour, not a fault. |
dns_authority | string<cloudflare, other, unknown> | Oui | Whose nameservers the zone was delegated to when last measured. unknown means the lookup did not answer — never that it is delegated elsewhere. |
catch_all | string | Oui | Where mail to any address on this domain is delivered. Empty when no forwarding alias exists — a domain with no deliverable destination gets no alias rather than one pointing… |
last_converged_at | string | Non | When the world last agreed with the intended state. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429