Intercom API (unofficial showcase)
POST/contacts/{contact_id}/companies

Attach a company to a contact

Attaches a company to a specific contact. Include the company's Intercom identifier in the request body to create the association.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
contact_idstringrequired
The unique identifier of the contact to attach the company to.
Intercom-Versionstringoptional
API version to use for the request. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

The company to associate with the contact.

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

4 status codes
200Returns the company object that was attached to the contact.
typestringoptional
Value is `company`
Allowed:company
idstringoptional
The Intercom defined id representing the company.
namestringoptional
The name of the company.
app_idstringoptional
The Intercom defined code of the workspace the company is associated to.
planobjectoptional
company_idstringoptional
The company id you have defined for the company.
remote_created_atintegeroptional
The time the company was created by you.
created_atintegeroptional
The time the company was added in Intercom.
updated_atintegeroptional
The last time the company was updated.
last_request_atintegeroptional
The time the company last recorded making a request.
sizeintegeroptional
The number of employees in the company.
websitestringoptional
The URL for the company website.
industrystringoptional
The industry that the company operates in.
monthly_spendintegeroptional
How much revenue the company generates for your business.
session_countintegeroptional
How many sessions the company has recorded.
user_countintegeroptional
The number of users in the company.
custom_attributesobjectoptional
The custom attributes you have set on the company.
tagsobjectoptional
The list of tags associated with the company
segmentsobjectoptional
The list of segments associated with the company
notesobjectoptional
The list of notes associated with the company
400Returned when the request body is invalid or omits the required company `id`.

2 documented failures

  • parameter_not_found

    company not specified

  • contact_company_limit_exceeded

    Contact has reached the maximum of 1000 company associations

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the company does not exist.

One documented failure

  • company_not_found

    Company Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

The request body must include id, the unique identifier of the company to attach; omitting it returns a 400. A 401 is returned when the request is unauthorized. A 404 is returned when the company identified by id does not exist.