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 %}
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Intercom-Version |
String | No |
Possible values:
Default value: "2.12" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
custom_attributes |
Object | No |
A hash of key/value pairs containing any other data about the company you want Intercom to store. |
name |
String | No |
The name of the Company |
size |
Integer | No |
The number of employees in this company. |
industry |
String | No |
The industry that this company operates in. |
remote_created_at |
Integer | No |
The time the company was created by you. |
website |
String | No |
The URL for this company's website. Please note that the value specified here is not validated. Accepts any string. |
plan |
String | No |
The name of the plan you have associated with the company. |
company_id |
String | No |
The company id you have defined for the company. Can't be updated |
monthly_spend |
Integer | No |
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.. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.