domains
POST /v1/domains/{domainId}/email-routing/enabled
Turn inbound email routing on for a domain.
Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran domains.dns.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/email-routing/enabled \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
**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`.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
domainId (path) | Uuid | Ya | The domain's id. |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
confirm_domain | string | Tidak | 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… |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
domain_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | string | Ya | — |
supported | boolean | Ya | — |
enabled | boolean | Ya | — |
status | string | Ya | The provider's own word for the zone's state. Displayed, never branched on. |
dns_ready | boolean | Ya | 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[] | Ya | — |
rules | DomainEmailRoutingRule[] | Ya | — |
catch_all | DomainEmailRoutingRule | Ya | — |
addresses | DomainEmailRoutingAddress[] | Ya | — |
addresses_readable | boolean | Ya | `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 | Ya | `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 | Ya | `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 | Ya | What turning routing on would replace, measured against the zone's live records. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 409 · 422 · 429 · 503