domains

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

Turn inbound email routing off for a domain.

همه نقاط پایانی domains

همهٔ مستندات توسعه‌دهندگان

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز domains.dns.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X DELETE https://api.zinndigital.com/v1/domains/{domainId}/email-routing/enabled \
  -H "Authorization: Bearer zdk_live_…"

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Ungated, deliberately: turning routing off gives the customer their mail back rather than taking it, and gating an exit is how a customer gets stuck. Requires domains.dns.manage.

پارامترها

نامنوعالزامیچیست
domainId (path)UuidبلهThe domain's id.

پاسخ

نامنوعالزامیچیست
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 empty…
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 different…
impactDomainEmailRoutingImpactبلهWhat turning routing on would replace, measured against the zone's live records.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 422 · 429 · 503