domains

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

Turn inbound email routing on for a domain.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن domains.dns.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

التفاصيل

**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_domain`	`string`	لا	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_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`fqdn`	`string`	نعم	—
`supported`	`boolean`	نعم	—
`enabled`	`boolean`	نعم	—
`status`	`string`	نعم	The provider's own word for the zone's state. Displayed, never branched on.
`dns_ready`	`boolean`	نعم	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[]`	نعم	—
`rules`	`DomainEmailRoutingRule[]`	نعم	—
`catch_all`	`DomainEmailRoutingRule`	نعم	—
`addresses`	`DomainEmailRoutingAddress[]`	نعم	—
`addresses_readable`	`boolean`	نعم	`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`	نعم	`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`	نعم	`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`	نعم	What turning routing on would replace, measured against the zone's live records.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

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

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