domains

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

Turn inbound email routing on for a domain.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 domains.dns.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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 运行请求，以便您查看实际的响应。在 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