domains

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

Turn inbound email routing on for a domain.

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 domains.dns.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 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

인증