POST /accounts/{account_id}/email/routing/rules/plan
Computes the Email Routing rule changes that would be needed to reconcile a Wrangler-managed desired ruleset. This endpoint is read-only and does not create, update, or delete rules.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_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 |
|---|---|---|---|
rules[] |
Array | No |
Desired normal Email Routing rules managed by the deploying Worker. |
rules[].actions[] |
Array | Yes |
List actions patterns. |
rules[].actions[].type |
String | Yes |
Type of supported action. Valid values:
|
rules[].actions[].value[] |
Array | No | |
rules[].matchers[] |
Array | Yes |
Matching patterns to forward to your actions. |
rules[].matchers[].field |
String | No |
Field for type matcher. Valid values:
|
rules[].matchers[].type |
String | Yes |
Type of matcher. Valid values:
|
rules[].matchers[].value |
String | No |
Value for matcher. |
rules[].enabled |
Boolean | No |
Routing rule status. Valid values:
Default value: true |
owner_worker_tag |
String | Yes |
Public tag (script_tag) of the Worker that owns this rule. Required when
|
catch_all_rules[] |
Array | No |
Desired catch-all Email Routing rules managed by the deploying Worker. |
catch_all_rules[].rule |
Object | Yes | |
catch_all_rules[].rule.actions[] |
Array | Yes |
List actions for the catch-all routing rule. |
catch_all_rules[].rule.actions[].type |
String | Yes |
Type of action for catch-all rule. Valid values:
|
catch_all_rules[].rule.actions[].value[] |
Array | No | |
catch_all_rules[].rule.matchers[] |
Array | Yes |
List of matchers for the catch-all routing rule. |
catch_all_rules[].rule.matchers[].type |
String | Yes |
Type of matcher. Default is 'all'. Valid values:
|
catch_all_rules[].rule.enabled |
Boolean | No |
Routing rule status. Valid values:
Default value: true |
catch_all_rules[].target |
String | Yes |
Catch-all target to plan for, using the |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.