domains

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

Turn inbound email routing on for a domain.

सबै domains इन्डपइन्टहरू

सबै विकासकर्ता कागजातहरू

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग domains.dns.manage अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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 कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ 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_domainstringहैन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_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 · 409 · 422 · 429 · 503