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.

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.

SecurityHTTP: bearerAuth

Request

header Parameters

Intercom-Version

string (intercom_version)

Default: 2.10

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

Enum: "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" "Unstable"

Example: 2.10

Request Body schema: application/json

name	string The name of the Company
company_id	string The company id you have defined for the company. Can't be updated
plan	string The name of the plan you have associated with the company.
size	integer The number of employees in this company.
website	string The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.
industry	string The industry that this company operates in.
	object A hash of key/value pairs containing any other data about the company you want Intercom to store.
remote_created_at	integer The time the company was created by you.
monthly_spend	integer 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..

post

/companies

Request samples
Payload
curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R
5 more
application/json
Successful
{
"company_id": "company_remote_id",
"name": "my company",
"remote_created_at": 1374138000
}

Responses

200

Successful

Response Schema: application/json

type	string Value is `company` Value: "company"
id	string The Intercom defined id representing the company.
name	string The name of the company.
app_id	string The Intercom defined code of the workspace the company is associated to.
	object
company_id	string The company id you have defined for the company.
remote_created_at	integer The time the company was created by you.
created_at	integer The time the company was added in Intercom.
updated_at	integer The last time the company was updated.
last_request_at	integer The time the company last recorded making a request.
size	integer The number of employees in the company.
website	string The URL for the company website.
industry	string The industry that the company operates in.
monthly_spend	integer How much revenue the company generates for your business.
session_count	integer How many sessions the company has recorded.
user_count	integer The number of users in the company.
	object The custom attributes you have set on the company.
	object The list of tags associated with the company
	object The list of segments associated with the company

400

Bad Request

401

Unauthorized

Response samples
200
400
401
application/json
Successful
{
"type": "company",
"company_id": "company_remote_id",
"id": "660e72ac6abd01bd27af60cf",
"app_id": "this_is_an_id105_that_should_be_at_least_",
"name": "my company",
"remote_created_at": 1374138000,
"created_at": 1712222892,
"updated_at": 1712222892,
"monthly_spend": 0,
"session_count": 0,
"user_count": 0,
"tags": {
"type": "tag.list",
"tags": [ ]
},
"segments": {
"type": "segment.list",
"segments": [ ]
},
"plan": { },
"custom_attributes": {
"creation_source": "api"
}
}