domains

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

Turn inbound email routing on for a domain.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão domains.dns.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/email-routing/enabled \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

**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`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`domainId (path)`	`Uuid`	Sim	The domain's id.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`confirm_domain`	`string`	Não	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…

Resposta

Nome	Tipo	Obrigatório	O que é
`domain_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`fqdn`	`string`	Sim	—
`supported`	`boolean`	Sim	—
`enabled`	`boolean`	Sim	—
`status`	`string`	Sim	The provider's own word for the zone's state. Displayed, never branched on.
`dns_ready`	`boolean`	Sim	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[]`	Sim	—
`rules`	`DomainEmailRoutingRule[]`	Sim	—
`catch_all`	`DomainEmailRoutingRule`	Sim	—
`addresses`	`DomainEmailRoutingAddress[]`	Sim	—
`addresses_readable`	`boolean`	Sim	`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`	Sim	`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`	Sim	`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`	Sim	What turning routing on would replace, measured against the zone's live records.

Erros que este endpoint pode retornar

401 · 403 · 404 · 409 · 422 · 429 · 503

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