Skip to content
Start here

Catch Alls

Get catch-all rule
GET/zones/{zone_id}/email/routing/rules/catch_all
Update catch-all rule
PUT/zones/{zone_id}/email/routing/rules/catch_all
ModelsExpand Collapse
CatchAllAction object { type, value }

Action for the catch-all routing rule.

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

Type of action for catch-all rule.

One of the following:
"drop"
"forward"
"worker"
value: optional array of string
CatchAllMatcher object { type }

Matcher for catch-all routing rule.

type: "all"

Type of matcher. Default is ‘all’.

CatchAllGetResponse object { id, actions, enabled, 3 more }
id: optional string

Routing rule identifier.

maxLength32
actions: optional array of CatchAllAction { type, value }

List actions for the catch-all routing rule.

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

Type of action for catch-all rule.

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 CatchAllMatcher { type }

List of matchers for the catch-all routing rule.

type: "all"

Type of matcher. Default is ‘all’.

name: optional string

Routing rule name.

maxLength256
Deprecatedtag: optional string

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

maxLength32
CatchAllUpdateResponse object { id, actions, enabled, 3 more }
id: optional string

Routing rule identifier.

maxLength32
actions: optional array of CatchAllAction { type, value }

List actions for the catch-all routing rule.

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

Type of action for catch-all rule.

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 CatchAllMatcher { type }

List of matchers for the catch-all routing rule.

type: "all"

Type of matcher. Default is ‘all’.

name: optional string

Routing rule name.

maxLength256
Deprecatedtag: optional string

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

maxLength32