domains

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

Turn inbound email routing on for a domain.

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس 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 کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو 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 empty…
`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 different…
`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