--- title: Create routing rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Email Routing](https://developers.cloudflare.com/api/go/resources/email_routing) [Rules](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create routing rule client.EmailRouting.Rules.New(ctx, params) (\*[EmailRoutingRule](), error) 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
params RuleNewParams ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property
Actions param.Field\[\[]Action] Body param: List actions patterns.
Type ActionType Type of supported action. One of the following: const ActionTypeDrop ActionType = "drop" Link to this property const ActionTypeForward ActionType = "forward" Link to this property const ActionTypeWorker ActionType = "worker" Link to this property
Link to this property Value \[]stringOptional List of values for the action. Currently limited to a single value. Link to this property
Link to this property
Matchers param.Field\[\[]Matcher] Body param: Matching patterns to forward to your actions.
Type MatcherType Type of matcher. One of the following: const MatcherTypeAll MatcherType = "all" Link to this property const MatcherTypeLiteral MatcherType = "literal" Link to this property
Link to this property Field MatcherFieldOptional Field for type matcher. Link to this property Value stringOptional Value for matcher. maxLength90 Link to this property
Link to this property
Enabled param.Field\[RuleNewParamsEnabled]Optional Body param: Routing rule status. const RuleNewParamsEnabledTrue RuleNewParamsEnabled = true Link to this property const RuleNewParamsEnabledFalse RuleNewParamsEnabled = false Link to this property
Link to this property Name param.Field\[string]Optional Body param: Routing rule name. maxLength256 Link to this property OwnerWorkerTag param.Field\[string]Optional Body param: Public tag (script\_tag) of the Worker that owns this rule. Required when source is wrangler. maxLength32 Link to this property Priority param.Field\[float64]Optional Body param: Priority of the routing rule. minimum0 Link to this property
Source param.Field\[RuleNewParamsSource]Optional Body param: 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. const RuleNewParamsSourceAPI RuleNewParamsSource = "api" Link to this property const RuleNewParamsSourceWrangler RuleNewParamsSource = "wrangler" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type EmailRoutingRule struct{…} ID stringOptional Routing rule identifier. maxLength32 Link to this property
Actions \[]ActionOptional List actions patterns.
Type ActionType Type of supported action. One of the following: const ActionTypeDrop ActionType = "drop" Link to this property const ActionTypeForward ActionType = "forward" Link to this property const ActionTypeWorker ActionType = "worker" Link to this property
Link to this property Value \[]stringOptional List of values for the action. Currently limited to a single value. Link to this property
Link to this property
Enabled EmailRoutingRuleEnabledOptional Routing rule status. One of the following: const EmailRoutingRuleEnabledTrue EmailRoutingRuleEnabled = true Link to this property const EmailRoutingRuleEnabledFalse EmailRoutingRuleEnabled = false Link to this property
Link to this property
Matchers \[]MatcherOptional Matching patterns to forward to your actions.
Type MatcherType Type of matcher. One of the following: const MatcherTypeAll MatcherType = "all" Link to this property const MatcherTypeLiteral MatcherType = "literal" Link to this property
Link to this property Field MatcherFieldOptional Field for type matcher. Link to this property Value stringOptional Value for matcher. maxLength90 Link to this property
Link to this property Name stringOptional Routing rule name. maxLength256 Link to this property Priority float64Optional Priority of the routing rule. minimum0 Link to this property
Source EmailRoutingRuleSourceOptional 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: const EmailRoutingRuleSourceAPI EmailRoutingRuleSource = "api" Link to this property const EmailRoutingRuleSourceWrangler EmailRoutingRuleSource = "wrangler" Link to this property
Link to this property DeprecatedTag stringOptional 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 Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/email_routing" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) emailRoutingRule, err := client.EmailRouting.Rules.New(context.TODO(), email_routing.RuleNewParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Actions: cloudflare.F([]email_routing.ActionParam{email_routing.ActionParam{ Type: cloudflare.F(email_routing.ActionTypeForward), }}), Matchers: cloudflare.F([]email_routing.MatcherParam{email_routing.MatcherParam{ Type: cloudflare.F(email_routing.MatcherTypeLiteral), }}), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", emailRoutingRule.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" } } ```