provider Companies POST /companies
@utdk/intercom /companies
Create or Update a company
You can create or update a company. Companies will be only visible in Intercom when there is at least one associated user. Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. {% admonition type="warning" name="Using `company_id`" %} You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. {% /admonition %}
Intercom-Version header
enum: 1.0, 1.1, 1.2, 1.3…

Try it

Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

createorupdatecompany
POST/companies
You can create or update a company. Companies will be only visible in Intercom when there is at least one associated user. Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. {% admonition type="warning" name="Using `company_id`" %} You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. {% /admonition %}

Input

The name of the Company

The company id you have defined for the company. Can't be updated

The name of the plan you have associated with the company.

The number of employees in this company.

The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.

The industry that this company operates in.

A hash of key/value pairs containing any other data about the company you want Intercom to store.

The time the company was created by you.

How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import intercom from '@utdk/intercom';

await intercom.createorupdatecompany({
  "Intercom-Version": "2.14"
})