domains

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

Turn inbound email routing on for a domain.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს domains.dns.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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