Update routing rule

PUT

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/email/routing/rules/{rule_identifier}

Last modified:2022-12-16 13:48:33

Update actions and matches, or enable/disable specific routing rules.

Request

Path Params

rule_identifier

string

required

zone_identifier

string

required

Body Params application/json

actions

array[object (schemas-action) {2}]

required

List actions patterns.

type

enum<string>

required

Type of supported action.

Allowed values:

forwardworker

Example:

forward

value

array[string]

required

enabled

enum<boolean>

optional

Routing rule status.

Allowed values:

truefalse

Default:

true

Example:

true

matchers

array[object (matcher) {3}]

required

Matching patterns to forward to your actions.

field

enum<string>

required

Field for type matcher.

Allowed value:

Example:

type

enum<string>

required

Type of matcher.

Allowed value:

literal

Example:

literal

value

string

required

Value for matcher.

<= 90 characters

Example:

test@example.com

name

string

optional

Routing rule name.

<= 256 characters

Example:

Send to user@example.net rule.

priority

number

optional

Priority of the routing rule.

>= 0

Default:

Example

{
    "actions": [
        {
            "type": "forward",
            "value": [
                "destinationaddress@example.net"
            ]
        }
    ],
    "enabled": true,
    "matchers": [
        {
            "field": "to",
            "type": "literal",
            "value": "test@example.com"
        }
    ],
    "name": "Send to user@example.net rule.",
    "priority": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/zones//email/routing/rules/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "actions": [
        {
            "type": "forward",
            "value": [
                "destinationaddress@example.net"
            ]
        }
    ],
    "enabled": true,
    "matchers": [
        {
            "field": "to",
            "type": "literal",
            "value": "test@example.com"
        }
    ],
    "name": "Send to user@example.net rule.",
    "priority": 0
}'

Responses

🟢200Update routing rule response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Update routing rule response failure

Modified at 2022-12-16 13:48:33

Get routing rule

Get Email Routing settings