--- title: Email Routing --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Email Routing ##### [Get Email Routing settings](https://developers.cloudflare.com/api/resources/email_routing/methods/get) GET/zones/{zone\_id}/email/routing ##### [Update Email Routing settings](https://developers.cloudflare.com/api/resources/email_routing/methods/edit) PATCH/zones/{zone\_id}/email/routing ##### [Apply Email Routing settings](https://developers.cloudflare.com/api/resources/email_routing/methods/update) PUT/zones/{zone\_id}/email/routing ##### [Disable Email Routing](https://developers.cloudflare.com/api/resources/email_routing/methods/disable) Deprecated POST/zones/{zone\_id}/email/routing/disable ##### [Enable Email Routing](https://developers.cloudflare.com/api/resources/email_routing/methods/enable) Deprecated POST/zones/{zone\_id}/email/routing/enable ##### [Unlock Email Routing](https://developers.cloudflare.com/api/resources/email_routing/methods/unlock) Deprecated POST/zones/{zone\_id}/email/routing/unlock ##### ModelsExpand Collapse

Settings object {id, enabled, name, 6 more }

id: string Email Routing settings identifier. maxLength32 Link to this property

enabled: trueor false State of the zone settings for Email Routing.

One of the following: true Link to this property false Link to this property

Link to this property name: string Domain of your zone. Link to this property created: optional string The date and time the settings have been created. formatdate-time Link to this property modified: optional string The date and time the settings have been modified. formatdate-time Link to this property

skip\_wizard: optional trueor false Flag to check if the user skipped the configuration wizard.

One of the following: true Link to this property false Link to this property

Link to this property

status: optional "ready"or "unconfigured"or "misconfigured"or 2 more Show the state of your account, and the type or configuration error.

One of the following: "ready" Link to this property "unconfigured" Link to this property "misconfigured" Link to this property "misconfigured/locked" Link to this property "unlocked" Link to this property

Link to this property

support\_subaddress: optional trueor false Whether subaddressing (plus-addressing) is honored when matching incoming mail against routing rules.

One of the following: true Link to this property false Link to this property

Link to this property Deprecatedtag: optional string Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier) maxLength32 Link to this property

[Link to this property](<#(resource)%20email_routing%20%3E%20(model)%20settings%20%3E%20(schema)>) #### Email RoutingDNS ##### [Email Routing - DNS settings](https://developers.cloudflare.com/api/resources/email_routing/subresources/dns/methods/get) GET/zones/{zone\_id}/email/routing/dns ##### [Enable Email Routing](https://developers.cloudflare.com/api/resources/email_routing/subresources/dns/methods/create) POST/zones/{zone\_id}/email/routing/dns ##### [Unlock Email Routing DNS records](https://developers.cloudflare.com/api/resources/email_routing/subresources/dns/methods/edit) PATCH/zones/{zone\_id}/email/routing/dns ##### [Disable Email Routing](https://developers.cloudflare.com/api/resources/email_routing/subresources/dns/methods/delete) DELETE/zones/{zone\_id}/email/routing/dns ##### ModelsExpand Collapse

DNSRecord object {content, name, priority, 2 more } List of records needed to enable an Email Routing zone.

content: optional string DNS record content. Link to this property name: optional string DNS record name (or @ for the zone apex). maxLength255 Link to this property priority: optional number Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred. maximum65535 minimum0 Link to this property

ttl: optional numberor 1 Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ‘automatic’.

One of the following: number Link to this property 1 Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ‘automatic’. Link to this property

Link to this property

type: optional "A"or "AAAA"or "CNAME"or 15 more DNS record type.

Link to this property

[Link to this property](<#(resource)%20email_routing.dns%20%3E%20(model)%20dns_record%20%3E%20(schema)>)

DNSGetResponse = array of DNSRecord { content, name, priority, 2 more }

ttl: optional numberor 1 Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ‘automatic’.

One of the following: number Link to this property 1 Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ‘automatic’. Link to this property

Link to this property

type: optional "A"or "AAAA"or "CNAME"or 15 more DNS record type.

Link to this property

[Link to this property](<#(resource)%20email_routing.dns%20%3E%20(model)%20dns_get_response%20%3E%20(schema)>) #### Email RoutingRules ##### [List account or zone routing rules](https://developers.cloudflare.com/api/resources/email_routing/subresources/rules/methods/list) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/email/routing/rules ##### [Get routing rule](https://developers.cloudflare.com/api/resources/email_routing/subresources/rules/methods/get) GET/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### [Create routing rule](https://developers.cloudflare.com/api/resources/email_routing/subresources/rules/methods/create) POST/zones/{zone\_id}/email/routing/rules ##### [Update routing rule](https://developers.cloudflare.com/api/resources/email_routing/subresources/rules/methods/update) PUT/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### [Delete routing rule](https://developers.cloudflare.com/api/resources/email_routing/subresources/rules/methods/delete) DELETE/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### ModelsExpand Collapse

Action object {type, value } Actions pattern.

type: "drop"or "forward"or "worker" Type of supported action.

One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property

Link to this property value: optional array of string List of values for the action. Currently limited to a single value. Link to this property

[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(model)%20action%20%3E%20(schema)>)

EmailRoutingRule object {id, actions, enabled, 5 more }

id: optional string Routing rule identifier. maxLength32 Link to this property

actions: optional array of Action { type, value } List actions patterns.

type: "drop"or "forward"or "worker" Type of supported action.

One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property

Link to this property value: optional array of string List of values for the action. Currently limited to a single value. Link to this property

Link to this property

enabled: optional trueor false Routing rule status.

One of the following: true Link to this property false Link to this property

Link to this property

matchers: optional array of Matcher { type, field, value } Matching patterns to forward to your actions.

type: "all"or "literal" Type of matcher.

One of the following: "all" Link to this property "literal" Link to this property

Link to this property field: optional "to" Field for type matcher. Link to this property value: optional string Value for matcher. maxLength90 Link to this property

Link to this property name: optional string Routing rule name. maxLength256 Link to this property priority: optional number Priority of the routing rule. minimum0 Link to this property

source: optional "api"or "wrangler" Who manages the rule. api covers dashboard, generic API, and Terraform; wrangler means the rule is managed by a Worker’s wrangler.jsonc. Defaults to api when omitted on write.

One of the following: "api" Link to this property "wrangler" Link to this property

Link to this property Deprecatedtag: optional string Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property

[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(model)%20email_routing_rule%20%3E%20(schema)>)

Matcher object {type, field, value } Matching pattern to forward your actions.

type: "all"or "literal" Type of matcher.

One of the following: "all" Link to this property "literal" Link to this property

Link to this property field: optional "to" Field for type matcher. Link to this property value: optional string Value for matcher. maxLength90 Link to this property

[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(model)%20matcher%20%3E%20(schema)>) #### Email RoutingRulesCatch Alls ##### [Get catch-all rule](https://developers.cloudflare.com/api/resources/email_routing/subresources/rules/subresources/catch_alls/methods/get) GET/zones/{zone\_id}/email/routing/rules/catch\_all ##### [Update catch-all rule](https://developers.cloudflare.com/api/resources/email_routing/subresources/rules/subresources/catch_alls/methods/update) PUT/zones/{zone\_id}/email/routing/rules/catch\_all ##### ModelsExpand Collapse

CatchAllAction object {type, value } Action for the catch-all routing rule.

type: "drop"or "forward"or "worker" Type of action for catch-all rule.

One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property

Link to this property value: optional array of string List of values for the action. Currently limited to a single value. Link to this property

[Link to this property](<#(resource)%20email_routing.rules.catch_alls%20%3E%20(model)%20catch_all_action%20%3E%20(schema)>)

CatchAllMatcher object {type } Matcher for catch-all routing rule.

type: "all" Type of matcher. Default is ‘all’. Link to this property

[Link to this property](<#(resource)%20email_routing.rules.catch_alls%20%3E%20(model)%20catch_all_matcher%20%3E%20(schema)>)

CatchAllGetResponse object {id, actions, enabled, 4 more }

id: optional string Routing rule identifier. maxLength32 Link to this property

actions: optional array of CatchAllAction { type, value } List actions for the catch-all routing rule.

type: "drop"or "forward"or "worker" Type of action for catch-all rule.

One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property

Link to this property value: optional array of string List of values for the action. Currently limited to a single value. Link to this property

Link to this property

enabled: optional trueor false Routing rule status.

One of the following: true Link to this property false Link to this property

Link to this property

matchers: optional array of CatchAllMatcher { type } List of matchers for the catch-all routing rule.

type: "all" Type of matcher. Default is ‘all’. Link to this property

Link to this property name: optional string Routing rule name. maxLength256 Link to this property

One of the following: "api" Link to this property "wrangler" Link to this property

Link to this property Deprecatedtag: optional string Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property

[Link to this property](<#(resource)%20email_routing.rules.catch_alls%20%3E%20(model)%20catch_all_get_response%20%3E%20(schema)>)

CatchAllUpdateResponse object {id, actions, enabled, 4 more }

id: optional string Routing rule identifier. maxLength32 Link to this property

actions: optional array of CatchAllAction { type, value } List actions for the catch-all routing rule.

type: "drop"or "forward"or "worker" Type of action for catch-all rule.

One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property

Link to this property value: optional array of string List of values for the action. Currently limited to a single value. Link to this property

Link to this property

enabled: optional trueor false Routing rule status.

One of the following: true Link to this property false Link to this property

Link to this property

matchers: optional array of CatchAllMatcher { type } List of matchers for the catch-all routing rule.

type: "all" Type of matcher. Default is ‘all’. Link to this property

Link to this property name: optional string Routing rule name. maxLength256 Link to this property

One of the following: "api" Link to this property "wrangler" Link to this property

Link to this property Deprecatedtag: optional string Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property

[Link to this property](<#(resource)%20email_routing.rules.catch_alls%20%3E%20(model)%20catch_all_update_response%20%3E%20(schema)>) #### Email RoutingAccount Rules ##### [List account or zone routing rules](https://developers.cloudflare.com/api/resources/email_routing/subresources/account_rules/methods/list) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/email/routing/rules ##### ModelsExpand Collapse

AccountRule object {id, actions, enabled, 6 more }

id: optional string Routing rule identifier. maxLength32 Link to this property

actions: optional array of Action { type, value } List actions patterns.

type: "drop"or "forward"or "worker" Type of supported action.

One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property

Link to this property value: optional array of string List of values for the action. Currently limited to a single value. Link to this property

Link to this property

enabled: optional trueor false Routing rule status.

One of the following: true Link to this property false Link to this property

Link to this property

matchers: optional array of Matcher { type, field, value } Matching patterns to forward to your actions.

type: "all"or "literal" Type of matcher.

One of the following: "all" Link to this property "literal" Link to this property

Link to this property field: optional "to" Field for type matcher. Link to this property value: optional string Value for matcher. maxLength90 Link to this property

Link to this property name: optional string Routing rule name. maxLength256 Link to this property priority: optional number Priority of the routing rule. minimum0 Link to this property

One of the following: "api" Link to this property "wrangler" Link to this property

Link to this property Deprecatedtag: optional string Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property

zone: optional object {name, tag } Zone information for the routing rule.

name: optional string Zone name. Link to this property tag: optional string Zone tag. maxLength32 Link to this property

Link to this property

[Link to this property](<#(resource)%20email_routing.account_rules%20%3E%20(model)%20account_rule%20%3E%20(schema)>) #### Email RoutingAddresses ##### [List destination addresses](https://developers.cloudflare.com/api/resources/email_routing/subresources/addresses/methods/list) GET/accounts/{account\_id}/email/routing/addresses ##### [Get a destination address](https://developers.cloudflare.com/api/resources/email_routing/subresources/addresses/methods/get) GET/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### [Create a destination address](https://developers.cloudflare.com/api/resources/email_routing/subresources/addresses/methods/create) POST/accounts/{account\_id}/email/routing/addresses ##### [Update destination address](https://developers.cloudflare.com/api/resources/email_routing/subresources/addresses/methods/edit) PATCH/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### [Delete destination address](https://developers.cloudflare.com/api/resources/email_routing/subresources/addresses/methods/delete) DELETE/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### ModelsExpand Collapse

Address object {id, created, email, 3 more }

id: optional string Destination address identifier. maxLength32 Link to this property created: optional string The date and time the destination address has been created. formatdate-time Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property modified: optional string The date and time the destination address was last modified. formatdate-time Link to this property Deprecatedtag: optional string Destination address tag. (Deprecated, replaced by destination address identifier) maxLength32 Link to this property verified: optional string The date and time the destination address has been verified. Null means not verified yet. formatdate-time Link to this property

[Link to this property](<#(resource)%20email_routing.addresses%20%3E%20(model)%20address%20%3E%20(schema)>)