Rules

List routing rules

GET/zones/{zone_id}/email/routing/rules

Get routing rule

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

Create routing rule

POST/zones/{zone_id}/email/routing/rules

Update routing rule

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

Delete routing rule

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

ModelsExpand Collapse

Action = object { type, value }

Actions pattern.

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

Type of supported action.

One of the following:

"drop"

"forward"

"worker"

value: optional array of string

EmailRoutingRule = object { id, actions, enabled, 4 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

Routing rule name.

maxLength256

priority: optional number

Priority of the routing rule.

minimum0

Deprecatedtag: optional string

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

maxLength32

Matcher = object { type, field, value }

Matching pattern to forward 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

RulesCatch 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'.

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'.

Routing rule name.

maxLength256

Deprecatedtag: optional string

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

maxLength32