--- title: Email Routing --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/email_routing/methods/get) client.emailRouting.get(EmailRoutingGetParams {zone\_id } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } GET/zones/{zone\_id}/email/routing ##### [Update Email Routing settings](https://developers.cloudflare.com/api/typescript/resources/email_routing/methods/edit) client.emailRouting.edit(EmailRoutingEditParams {zone\_id, enabled, skip\_wizard, support\_subaddress } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } PATCH/zones/{zone\_id}/email/routing ##### [Apply Email Routing settings](https://developers.cloudflare.com/api/typescript/resources/email_routing/methods/update) client.emailRouting.update(EmailRoutingUpdateParams {zone\_id, enabled, skip\_wizard, support\_subaddress } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } PUT/zones/{zone\_id}/email/routing ##### [Disable Email Routing](https://developers.cloudflare.com/api/typescript/resources/email_routing/methods/disable) Deprecated client.emailRouting.disable(EmailRoutingDisableParams {zone\_id } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } POST/zones/{zone\_id}/email/routing/disable ##### [Enable Email Routing](https://developers.cloudflare.com/api/typescript/resources/email_routing/methods/enable) Deprecated client.emailRouting.enable(EmailRoutingEnableParams {zone\_id } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } POST/zones/{zone\_id}/email/routing/enable ##### [Unlock Email Routing](https://developers.cloudflare.com/api/typescript/resources/email_routing/methods/unlock) Deprecated client.emailRouting.unlock(EmailRoutingUnlockParams {zone\_id, name } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } POST/zones/{zone\_id}/email/routing/unlock ##### ModelsExpand Collapse
Settings {id, enabled, name, 6 more } id: string Email Routing settings identifier. maxLength32 Link to this property
enabled: true| 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?: string The date and time the settings have been created. formatdate-time Link to this property modified?: string The date and time the settings have been modified. formatdate-time Link to this property
skip\_wizard?: true| 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?: "ready"| "unconfigured"| "misconfigured"| 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?: true| 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?: 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/typescript/resources/email_routing/subresources/dns/methods/get) client.emailRouting.dns.get(DNSGetParams {zone\_id, subdomain } params, RequestOptionsoptions?): [DNSGetResponse]() {content, name, priority, 2 more } GET/zones/{zone\_id}/email/routing/dns ##### [Enable Email Routing](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/dns/methods/create) client.emailRouting.dns.create(DNSCreateParams {zone\_id, name } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } POST/zones/{zone\_id}/email/routing/dns ##### [Unlock Email Routing DNS records](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/dns/methods/edit) client.emailRouting.dns.edit(DNSEditParams {zone\_id, name } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } PATCH/zones/{zone\_id}/email/routing/dns ##### [Disable Email Routing](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/dns/methods/delete) client.emailRouting.dns.delete(DNSDeleteParams {zone\_id } params, RequestOptionsoptions?): [Settings]() {id, enabled, name, 6 more } DELETE/zones/{zone\_id}/email/routing/dns ##### ModelsExpand Collapse
DNSRecord {content, name, priority, 2 more } List of records needed to enable an Email Routing zone. content?: string DNS record content. Link to this property name?: string DNS record name (or @ for the zone apex). maxLength255 Link to this property priority?: 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?: number| 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 1 Link to this property
Link to this property
Link to this property
type?: "A"| "AAAA"| "CNAME"| 15 more DNS record type. One of the following: "A" Link to this property "AAAA" Link to this property "CNAME" Link to this property "HTTPS" Link to this property "TXT" Link to this property "SRV" Link to this property "LOC" Link to this property "MX" Link to this property "NS" Link to this property "CERT" Link to this property "DNSKEY" Link to this property "DS" Link to this property "NAPTR" Link to this property "SMIMEA" Link to this property "SSHFP" Link to this property "SVCB" Link to this property "TLSA" Link to this property "URI" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_routing.dns%20%3E%20(model)%20dns_record%20%3E%20(schema)>)
DNSGetResponse = Array<DNSRecord {content, name, priority, 2 more } > content?: string DNS record content. Link to this property name?: string DNS record name (or @ for the zone apex). maxLength255 Link to this property priority?: 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?: number| 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 1 Link to this property
Link to this property
Link to this property
type?: "A"| "AAAA"| "CNAME"| 15 more DNS record type. One of the following: "A" Link to this property "AAAA" Link to this property "CNAME" Link to this property "HTTPS" Link to this property "TXT" Link to this property "SRV" Link to this property "LOC" Link to this property "MX" Link to this property "NS" Link to this property "CERT" Link to this property "DNSKEY" Link to this property "DS" Link to this property "NAPTR" Link to this property "SMIMEA" Link to this property "SSHFP" Link to this property "SVCB" Link to this property "TLSA" Link to this property "URI" Link to this property
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/typescript/resources/email_routing/subresources/rules/methods/list) client.emailRouting.rules.list(RuleListParams {account\_id, zone\_id, enabled, 2 more } params?, RequestOptionsoptions?): V4PagePaginationArray< [AccountRule]() {id, actions, enabled, 6 more } > GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/email/routing/rules ##### [Get routing rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/get) client.emailRouting.rules.get(stringruleIdentifier, RuleGetParams {zone\_id } params, RequestOptionsoptions?): [EmailRoutingRule]() {id, actions, enabled, 5 more } GET/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### [Create routing rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/create) client.emailRouting.rules.create(RuleCreateParams {zone\_id, actions, matchers, 5 more } params, RequestOptionsoptions?): [EmailRoutingRule]() {id, actions, enabled, 5 more } POST/zones/{zone\_id}/email/routing/rules ##### [Update routing rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/update) client.emailRouting.rules.update(stringruleIdentifier, RuleUpdateParams {zone\_id, actions, matchers, 5 more } params, RequestOptionsoptions?): [EmailRoutingRule]() {id, actions, enabled, 5 more } PUT/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### [Delete routing rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/delete) client.emailRouting.rules.delete(stringruleIdentifier, RuleDeleteParams {zone\_id } params, RequestOptionsoptions?): [EmailRoutingRule]() {id, actions, enabled, 5 more } DELETE/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### ModelsExpand Collapse
Action {type, value } Actions pattern.
type: "drop"| "forward"| "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?: Array<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 {id, actions, enabled, 5 more } id?: string Routing rule identifier. maxLength32 Link to this property
actions?: Array<Action {type, value } > List actions patterns.
type: "drop"| "forward"| "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?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
Link to this property
enabled?: true| false Routing rule status. One of the following: true Link to this property false Link to this property
Link to this property
matchers?: Array<Matcher {type, field, value } > Matching patterns to forward to your actions.
type: "all"| "literal" Type of matcher. One of the following: "all" Link to this property "literal" Link to this property
Link to this property field?: "to" Field for type matcher. Link to this property value?: string Value for matcher. maxLength90 Link to this property
Link to this property name?: string Routing rule name. maxLength256 Link to this property priority?: number Priority of the routing rule. minimum0 Link to this property
source?: "api"| "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?: 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 {type, field, value } Matching pattern to forward your actions.
type: "all"| "literal" Type of matcher. One of the following: "all" Link to this property "literal" Link to this property
Link to this property field?: "to" Field for type matcher. Link to this property value?: 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/typescript/resources/email_routing/subresources/rules/subresources/catch_alls/methods/get) client.emailRouting.rules.catchAlls.get(CatchAllGetParams {zone\_id } params, RequestOptionsoptions?): [CatchAllGetResponse]() {id, actions, enabled, 4 more } GET/zones/{zone\_id}/email/routing/rules/catch\_all ##### [Update catch-all rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/subresources/catch_alls/methods/update) client.emailRouting.rules.catchAlls.update(CatchAllUpdateParams {zone\_id, actions, matchers, 4 more } params, RequestOptionsoptions?): [CatchAllUpdateResponse]() {id, actions, enabled, 4 more } PUT/zones/{zone\_id}/email/routing/rules/catch\_all ##### ModelsExpand Collapse
CatchAllAction {type, value } Action for the catch-all routing rule.
type: "drop"| "forward"| "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?: Array<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 {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 {id, actions, enabled, 4 more } id?: string Routing rule identifier. maxLength32 Link to this property
actions?: Array<CatchAllAction {type, value } > List actions for the catch-all routing rule.
type: "drop"| "forward"| "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?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
Link to this property
enabled?: true| false Routing rule status. One of the following: true Link to this property false Link to this property
Link to this property
matchers?: Array<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?: string Routing rule name. maxLength256 Link to this property
source?: "api"| "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?: 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 {id, actions, enabled, 4 more } id?: string Routing rule identifier. maxLength32 Link to this property
actions?: Array<CatchAllAction {type, value } > List actions for the catch-all routing rule.
type: "drop"| "forward"| "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?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
Link to this property
enabled?: true| false Routing rule status. One of the following: true Link to this property false Link to this property
Link to this property
matchers?: Array<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?: string Routing rule name. maxLength256 Link to this property
source?: "api"| "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?: 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/typescript/resources/email_routing/subresources/account_rules/methods/list) client.emailRouting.accountRules.list(AccountRuleListParams {account\_id, zone\_id, enabled, 2 more } params?, RequestOptionsoptions?): V4PagePaginationArray< [AccountRule]() {id, actions, enabled, 6 more } > GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/email/routing/rules ##### ModelsExpand Collapse
AccountRule {id, actions, enabled, 6 more } id?: string Routing rule identifier. maxLength32 Link to this property
actions?: Array<Action {type, value } > List actions patterns.
type: "drop"| "forward"| "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?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
Link to this property
enabled?: true| false Routing rule status. One of the following: true Link to this property false Link to this property
Link to this property
matchers?: Array<Matcher {type, field, value } > Matching patterns to forward to your actions.
type: "all"| "literal" Type of matcher. One of the following: "all" Link to this property "literal" Link to this property
Link to this property field?: "to" Field for type matcher. Link to this property value?: string Value for matcher. maxLength90 Link to this property
Link to this property name?: string Routing rule name. maxLength256 Link to this property priority?: number Priority of the routing rule. minimum0 Link to this property
source?: "api"| "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?: string Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property
zone?: Zone {name, tag } Zone information for the routing rule. name?: string Zone name. Link to this property tag?: 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/typescript/resources/email_routing/subresources/addresses/methods/list) client.emailRouting.addresses.list(AddressListParams {account\_id, direction, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray< [Address]() {id, created, email, 3 more } > GET/accounts/{account\_id}/email/routing/addresses ##### [Get a destination address](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/addresses/methods/get) client.emailRouting.addresses.get(stringdestinationAddressIdentifier, AddressGetParams {account\_id } params, RequestOptionsoptions?): [Address]() {id, created, email, 3 more } GET/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### [Create a destination address](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/addresses/methods/create) client.emailRouting.addresses.create(AddressCreateParams {account\_id, email } params, RequestOptionsoptions?): [Address]() {id, created, email, 3 more } POST/accounts/{account\_id}/email/routing/addresses ##### [Update destination address](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/addresses/methods/edit) client.emailRouting.addresses.edit(stringdestinationAddressIdentifier, AddressEditParams {account\_id, status } params, RequestOptionsoptions?): [Address]() {id, created, email, 3 more } PATCH/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### [Delete destination address](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/addresses/methods/delete) client.emailRouting.addresses.delete(stringdestinationAddressIdentifier, AddressDeleteParams {account\_id } params, RequestOptionsoptions?): [Address]() {id, created, email, 3 more } DELETE/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### ModelsExpand Collapse
Address {id, created, email, 3 more } id?: string Destination address identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property email?: string The contact email address of the user. maxLength90 Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property Deprecatedtag?: string Destination address tag. (Deprecated, replaced by destination address identifier) maxLength32 Link to this property verified?: 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)>)