- Bulk delete companies
You can bulk delete companies by submitting an array of companies, each identified by its Intercom company id. Each company is permanently deleted, the same as with the single Delete a company endpoint. This can't be reversed.
If the workspace is under a legal hold, each item is rejected and the job's state ends as completed_with_errors.
The endpoint creates an async job that processes the deletes in the background. Use the returned job ID with GET /companies/bulk/{id} to check the job status.
- Maximum of 1,000 companies per request.
- You can append tasks to an existing job by including
job.idin the request body.
Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.
- The production API serverhttps://api.intercom.io/companies/bulk/delete
- The european API serverhttps://api.eu.intercom.io/companies/bulk/delete
- The australian API serverhttps://api.au.intercom.io/companies/bulk/delete
curl -i -X POST \
https://api.intercom.io/companies/bulk/delete \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: Preview' \
-d '{
"companies": [
{
"id": "531ee472cce572a6ec000006"
},
{
"id": "531ee472cce572a6ec000007"
}
]
}'Accepted
The current state of the job.
The time the job was last updated as a UNIX timestamp.
The time the job completed as a UNIX timestamp. Null if not yet completed.
{ "id": "job_v2_1", "type": "companies.bulk.job", "state": "running", "created_at": 1713360000, "updated_at": 1713360060, "completed_at": null, "tasks": [ { … } ], "url": "https://api.intercom.io/companies/bulk/job_v2_1" }