Skip to content

Commit 6c99eea

Browse files
VarshSureshclaude
andauthored
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>
1 parent 5984a5d commit 6c99eea

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9589,9 +9589,11 @@ paths:
95899589
description: |
95909590
Delete a single company.
95919591

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.
9592+
{% admonition type="warning" name="Permanent deletion" %}
9593+
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 %}
95939595

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.
95959597

95969598
{% admonition type="warning" %}
95979599
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.
@@ -9611,6 +9613,20 @@ paths:
96119613
deleted: true
96129614
schema:
96139615
"$ref": "#/components/schemas/deleted_company_object"
9616+
'422':
9617+
description: Workspace under legal hold
9618+
content:
9619+
application/json:
9620+
examples:
9621+
Workspace under legal hold:
9622+
value:
9623+
type: error.list
9624+
request_id: 2f6a8e3c-5b1d-4c7a-9e0f-3d8b6a1c4e72
9625+
errors:
9626+
- code: legal_hold
9627+
message: App is under legal hold, company deletion is not allowed
9628+
schema:
9629+
"$ref": "#/components/schemas/error"
96149630
'404':
96159631
description: Company Not Found
96169632
content:
@@ -11669,7 +11685,9 @@ paths:
1166911685
- Companies
1167011686
operationId: BulkDeleteCompanies
1167111687
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`.
1167311691

1167411692
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.
1167511693

0 commit comments

Comments
 (0)