INintercom
Companies

Delete a company

Changed on

Delete a single company.

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. A company.deleted webhook is sent when the company is deleted. These changes may take some time to be reflected in your workspace.

{% admonition type="warning" %} 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. {% /admonition %}

delete/companies/{company_id}

Request

  • Base URL
    https://api.intercom.io
  • Auth
    HTTP bearer

Path parameters

company_idstring required

The unique identifier for the company which is given by Intercom

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Response

Successful

idstring

The unique identifier for the company which is given by Intercom.

object'company'

The type of object which was deleted. - company

deletedboolean

Whether the company was deleted successfully or not.

Example response

{
  "id": "5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f",
  "object": "company",
  "deleted": true
}

Changes

  • 2.1421745f4700e8Revision changes
    • breaking

      added the new path request parameter company_id

    • warning

      deleted the path request parameter id