domains
POST /v1/domains/{domainId}/email-routing/enabled
Turn inbound email routing on for a domain.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie domains.dns.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/email-routing/enabled \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
**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`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
domainId (path) | Uuid | Ja | The domain's id. |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
confirm_domain | string | Nee | 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… |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
domain_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | string | Ja | — |
supported | boolean | Ja | — |
enabled | boolean | Ja | — |
status | string | Ja | The provider's own word for the zone's state. Displayed, never branched on. |
dns_ready | boolean | Ja | 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[] | Ja | — |
rules | DomainEmailRoutingRule[] | Ja | — |
catch_all | DomainEmailRoutingRule | Ja | — |
addresses | DomainEmailRoutingAddress[] | Ja | — |
addresses_readable | boolean | Ja | `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 empt… |
rules_readable | boolean | Ja | `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 | Ja | `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 differen… |
impact | DomainEmailRoutingImpact | Ja | What turning routing on would replace, measured against the zone's live records. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 409 · 422 · 429 · 503