Attach a Contact to a Company

Home

REST API Reference

Companies

You can attach a company to a single contact.

SecurityHTTP: bearerAuth

Request

path Parameters

required

string

The unique identifier for the contact which is given by Intercom

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

required

string

The unique identifier for the company which is given by Intercom

post

/contacts/{id}/companies

Request samples
Payload
curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R
5 more
application/json
Successful
{
"id": "660e72bd6abd01bd27af6121"
}

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

404

Company Not Found

Response samples
200
400
401
404
application/json
Successful
{
"type": "company",
"company_id": "1",
"id": "660e72bd6abd01bd27af6121",
"app_id": "this_is_an_id155_that_should_be_at_least_",
"name": "company6",
"remote_created_at": 1712222909,
"created_at": 1712222909,
"updated_at": 1712222909,
"monthly_spend": 0,
"session_count": 0,
"user_count": 1,
"tags": {
"type": "tag.list",
"tags": [ ]
},
"segments": {
"type": "segment.list",
"segments": [ ]
},
"plan": { },
"custom_attributes": { }
}