Account Rules

List account or zone routing rules

GET/{accounts_or_zones}/{account_or_zone_id}/email/routing/rules

ModelsExpand Collapse

AccountRule object { id, actions, enabled, 6 more }

id: optional string

Routing rule identifier.

maxLength32

actions: optional array of Action { type, value }

List actions patterns.

type: "drop" or "forward" or "worker"

Type of supported action.

One of the following:

"drop"

"forward"

"worker"

value: optional array of string

enabled: optional true or false

Routing rule status.

One of the following:

true

false

matchers: optional array of Matcher { type, field, value }

Matching patterns to forward to your actions.

type: "all" or "literal"

Type of matcher.

One of the following:

"all"

"literal"

field: optional "to"

Field for type matcher.

value: optional string

Value for matcher.

maxLength90

name: optional string

Routing rule name.

maxLength256

priority: optional number

Priority of the routing rule.

minimum0

source: optional "api" or "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"

"wrangler"

Deprecatedtag: optional string

Routing rule tag. (Deprecated, replaced by routing rule identifier)

maxLength32

zone: optional object { name, tag }

Zone information for the routing rule.

name: optional string

Zone name.

tag: optional string

Zone tag.

maxLength32