domains
POST /v1/domains/{domainId}/email-routing/enabled
Turn inbound email routing on for a domain.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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