--- title: Create routing rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Email Routing](https://developers.cloudflare.com/api/python/resources/email_routing) [Rules](https://developers.cloudflare.com/api/python/resources/email_routing/subresources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create routing rule email\_routing.rules.create(RuleCreateParams\*\*kwargs) -> [EmailRoutingRule]() POST/zones/{zone\_id}/email/routing/rules Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address). Forward actions require exactly one verified destination address. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Email Routing Rules Write` ##### ParametersExpand Collapse zone\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20email_routing.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
actions: Iterable\[ActionParam] List actions patterns.
type: Literal\["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: Optional\[List\[str]] 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(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20actions%20%3E%20(schema)>)
matchers: Iterable\[MatcherParam] Matching patterns to forward to your actions.
type: Literal\["all", "literal"] Type of matcher. One of the following: "all" Link to this property "literal" Link to this property
Link to this property field: Optional\[Literal\["to"]] Field for type matcher. Link to this property value: Optional\[str] Value for matcher. maxLength90 Link to this property
[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20matchers%20%3E%20(schema)>)
enabled: Optional\[Literal\[true, false]] Routing rule status. One of the following: true Link to this property false Link to this property
[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20enabled%20%3E%20(schema)>) name: Optional\[str] Routing rule name. maxLength256 [Link to this property](<#(resource)%20email_routing.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>) owner\_worker\_tag: Optional\[str] Public tag (script\_tag) of the Worker that owns this rule. Required when `source` is `wrangler`. maxLength32 [Link to this property](<#(resource)%20email_routing.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20owner_worker_tag%20%3E%20(schema)>) priority: Optional\[float] Priority of the routing rule. minimum0 [Link to this property](<#(resource)%20email_routing.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20priority%20%3E%20(schema)>)
source: Optional\[Literal\["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](<#(resource)%20email_routing.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20source%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class EmailRoutingRule: … id: Optional\[str] Routing rule identifier. maxLength32 Link to this property
actions: Optional\[List\[Action]] List actions patterns.
type: Literal\["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: Optional\[List\[str]] List of values for the action. Currently limited to a single value. Link to this property
Link to this property
enabled: Optional\[Literal\[true, false]] Routing rule status. One of the following: true Link to this property false Link to this property
Link to this property
matchers: Optional\[List\[Matcher]] Matching patterns to forward to your actions.
type: Literal\["all", "literal"] Type of matcher. One of the following: "all" Link to this property "literal" Link to this property
Link to this property field: Optional\[Literal\["to"]] Field for type matcher. Link to this property value: Optional\[str] Value for matcher. maxLength90 Link to this property
Link to this property name: Optional\[str] Routing rule name. maxLength256 Link to this property priority: Optional\[float] Priority of the routing rule. minimum0 Link to this property
source: Optional\[Literal\["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: Optional\[str] 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)>) ### Create routing rule Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) email_routing_rule = client.email_routing.rules.create( zone_id="023e105f4ecef8ad9ca31a8372d0c353", actions=[{ "type": "forward" }], matchers=[{ "type": "literal" }], ) print(email_routing_rule.id) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "a7e6fb77503c41d8a7f3113c6918f10c", "actions": [ { "type": "forward", "value": [ "destinationaddress@example.net" ] } ], "enabled": true, "matchers": [ { "type": "literal", "field": "to", "value": "test@example.com" } ], "name": "Send to user@example.net rule.", "priority": 0, "source": "api", "tag": "a7e6fb77503c41d8a7f3113c6918f10c" } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "a7e6fb77503c41d8a7f3113c6918f10c", "actions": [ { "type": "forward", "value": [ "destinationaddress@example.net" ] } ], "enabled": true, "matchers": [ { "type": "literal", "field": "to", "value": "test@example.com" } ], "name": "Send to user@example.net rule.", "priority": 0, "source": "api", "tag": "a7e6fb77503c41d8a7f3113c6918f10c" } } ```