Skip to content
View as Markdown

POST Bulk Delete Email Patterns

POST
/email-patterns/do-bulk-action

Delete several patterns in one request. delete_patterns is the only supported action — anything else is rejected.

There are two selection modes. By default the ids in pattern_ids are deleted. When select_all is truthy the id list is ignored and every pattern matching search is deleted — with an empty search, that is every pattern on the site.

Required capability: fcrm_manage_email_delete

Enforced by EmailPatternPolicy::handleBulkAction().

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
"action_name": "string",
"select_all": false,
"search": "string",
"pattern_ids": [
0
]
}

Responses

Patterns deleted.

application/json
JSON
{
"message": "string"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI