PUT /zones/{zone_id}/email/routing/rules/{rule_identifier}

Update actions and matches, or enable/disable specific routing rules. Forward actions require all destination addresses to be verified.

Servers

Path parameters

Name Type Required Description
rule_identifier String Yes
zone_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
source String No

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.

Valid values:

  • "wrangler"
  • "api"

Default value: "api"

priority Number No

Priority of the routing rule.

Default value: 0

actions[] Array Yes

List actions patterns.

actions[].type String Yes

Type of supported action.

Valid values:

  • "worker"
  • "drop"
  • "forward"
actions[].value[] Array No
name String No

Routing rule name.

matchers[] Array Yes

Matching patterns to forward to your actions.

matchers[].field String No

Field for type matcher.

Valid values:

  • "to"
matchers[].type String Yes

Type of matcher.

Valid values:

  • "all"
  • "literal"
matchers[].value String No

Value for matcher.

enabled Boolean No

Routing rule status.

Valid values:

  • true
  • false

Default value: true

owner_worker_tag String No

Public tag (script_tag) of the Worker that owns this rule. Required when source is wrangler.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.