Skip to content
View as Markdown

POST Bulk Action on Companies​

POST
/companies/do-bulk-action

Perform a bulk action on multiple companies. Supports deleting companies, changing status, changing type, and changing industry category. Companies can be selected by explicit IDs or by filter criteria (search + inline_filters). When using filter criteria, processes up to 50 companies per request in batches -- use last_id for pagination across multiple requests.

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",
"company_ids": [
0
],
"new_status": "string",
"search": "string",
"last_id": 0,
"company_query": {
"inline_filters": {
"company_categories": [
"string"
],
"company_types": [
"string"
]
}
}
}

Responses​

Bulk action completed or batch processed.

application/json
JSON
{
"message": "string",
"last_company_id": 0,
"completed_companies": 0,
"is_completed": true
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI