domains
POST /v1/domains/{domainId}/email-routing/enabled
Turn inbound email routing on for a domain.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation domains.dns.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/domains/{domainId}/email-routing/enabled \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
This can destroy a customer's inbound mail. Enabling republishes the zone's apex MX and SPF, so any mail service the domain already uses stops receiving. The endpoint therefore refuses with 409 MAIL_WOULD_BE_REPLACED when the zone carries mail records that are not the provider's own, and the override is typed, not clicked: confirm_domain must be the domain's own name. A boolean would be settable by a client that never showed the customer anything. The judgement runs on a confirmed call as well as a refused one, so the override is audit-logged with the same evidence as the refusal — otherwise the one case that actually replaced live mail would be the one case with no record of what was there. A zone that cannot be read is a refusal, never a pass. Requires domains.dns.manage.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
domainId (path) | Uuid | Oui | The domain's id. |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
confirm_domain | string | Non | The domain's own name, typed. Required only when impact.safe is false. A string rather than a boolean deliberately: a boolean would be settable by a client that never showed… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
domain_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | string | Oui | — |
supported | boolean | Oui | — |
enabled | boolean | Oui | — |
status | string | Oui | The provider's own word for the zone's state. Displayed, never branched on. |
dns_ready | boolean | Oui | Whether the provider reports the required DNS actually live. Distinct from enabled — a zone can be switched on with its MX not yet resolving. |
plan | DomainEmailRoutingDnsRecord[] | Oui | — |
rules | DomainEmailRoutingRule[] | Oui | — |
catch_all | DomainEmailRoutingRule | Oui | — |
addresses | DomainEmailRoutingAddress[] | Oui | — |
addresses_readable | boolean | Oui | false when the credential could not list destination addresses — a scope a customer's own token may legitimately lack. Separate from an empty addresses list, because an empty… |
rules_readable | boolean | Oui | false when the credential could not list the forwarding rules. Zone → Email Routing Rules is a separate Cloudflare permission from the one that reads the zone's routing… |
status_readable | boolean | Oui | false when the credential could not read the zone's routing settings — the half that supplies enabled, status, dns_ready and plan. On Cloudflare this is a different… |
impact | DomainEmailRoutingImpact | Oui | What turning routing on would replace, measured against the zone's live records. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 409 · 422 · 429 · 503