You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 6c99eea
Browse filesBrowse the repository at this point in the historyBrowse files
Document permanent company delete in Preview (#799)
* Document permanent company delete in Preview
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* Trim the Preview company delete description
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* Restore the Preview company retrieve and delete summaries
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: descriptions/0/api.intercom.io.yaml
+21-3Lines changed: 21 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -9589,9 +9589,11 @@ paths:
9589
9589
description: |
9590
9590
Delete a single company.
9591
9591
9592
-
The company record is kept in your workspace, but all contacts are detached. The contacts themselves are not deleted. Detaching contacts is permanent and can't be reversed. These changes may take some time to be reflected in your workspace.
Deleting a company is permanent and can't be reversed. The company record is removed from your workspace, along with its notes, tags and external references. Its contacts are detached and its conversations are unlinked from it; the contacts and conversations themselves are not deleted.
9594
+
{% /admonition %}
9593
9595
9594
-
The response returns `"deleted": true` as soon as the request is accepted; the contacts are detached in the background. A `company.deleted` webhook is sent after that work finishes, so it arrives some time after the response. No webhook is sent for a company that has no contacts attached, because there is nothing to detach.
9596
+
The response returns `"deleted": true` as soon as the request is accepted; the company is deleted in the background. A `company.deleted` webhook is sent once the deletion finishes, so it arrives some time after the response.
9595
9597
9596
9598
{% admonition type="warning" %}
9597
9599
Third-party integrations that sync companies into Intercom (for example, Salesforce or Chargebee) will recreate any company deleted through this endpoint on their next sync. To prevent recreation, remove or filter the company at the source integration before deleting it via the API.
message: App is under legal hold, company deletion is not allowed
9628
+
schema:
9629
+
"$ref": "#/components/schemas/error"
9614
9630
'404':
9615
9631
description: Company Not Found
9616
9632
content:
@@ -11669,7 +11685,9 @@ paths:
11669
11685
- Companies
11670
11686
operationId: BulkDeleteCompanies
11671
11687
description: |
11672
-
You can bulk delete companies by submitting an array of companies, each identified by its Intercom company `id`. Deleting a company detaches all of its associated contacts but keeps the company record itself — the same archival behaviour as the single [Delete a company](/docs/references/preview/rest-api/api.intercom.io/companies/deletecompany) endpoint.
11688
+
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](/docs/references/preview/rest-api/api.intercom.io/companies/deletecompany) endpoint. This can't be reversed.
11689
+
11690
+
If the workspace is under a legal hold, each item is rejected and the job's `state` ends as `completed_with_errors`.
11673
11691
11674
11692
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.
0 commit comments