domains

POST /v1/domains/{domainId}/email-routing/enabled

Turn inbound email routing on for a domain.

ټول domains پای ټکي

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د domains.dns.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/email-routing/enabled \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

**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`.

پارامترونه

نومډولاړیندا څه شی دی
domainId (path)UuidهوThe domain's id.

د غوښتنې بدن

نومډولاړیندا څه شی دی
confirm_domainstringنه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…

ځواب

نومډولاړیندا څه شی دی
domain_idUuidهوUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringهو
supportedbooleanهو
enabledbooleanهو
statusstringهوThe provider's own word for the zone's state. Displayed, never branched on.
dns_readybooleanهوWhether the provider reports the required DNS actually live. Distinct from `enabled` — a zone can be switched on with its `MX` not yet resolving.
planDomainEmailRoutingDnsRecord[]هو
rulesDomainEmailRoutingRule[]هو
catch_allDomainEmailRoutingRuleهو
addressesDomainEmailRoutingAddress[]هو
addresses_readablebooleanهو`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_readablebooleanهو`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_readablebooleanهو`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…
impactDomainEmailRoutingImpactهوWhat turning routing on would replace, measured against the zone's live records.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 409 · 422 · 429 · 503