Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
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 %}

post/companies

Headers

Intercom-Version'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' | '2.11' | '2.12' | '2.13' | '2.14'

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

Example:2.14

Request body

namestring

The name of the Company

company_idstring

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

planstring

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

sizeinteger

The number of employees in this company.

websitestring

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

industrystring

The industry that this company operates in.

custom_attributesobject

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

remote_created_atinteger

The time the company was created by you.

monthly_spendinteger

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..

Example request

{
  "name": "Intercom",
  "company_id": "625e90fc55ab113b6d92175f",
  "plan": "Enterprise",
  "website": "https://www.example.com",
  "industry": "Manufacturing",
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9
  },
  "remote_created_at": 1394531169,
  "monthly_spend": 1000
}

Response

Successful

type'company'

Value is company

idstring

The Intercom defined id representing the company.

namestring

The name of the company.

app_idstring

The Intercom defined code of the workspace the company is associated to.

company_idstring

The company id you have defined for the company.

remote_created_atinteger

The time the company was created by you.

created_atinteger

The time the company was added in Intercom.

updated_atinteger

The last time the company was updated.

last_request_atinteger

The time the company last recorded making a request.

sizeinteger

The number of employees in the company.

websitestring

The URL for the company website.

industrystring

The industry that the company operates in.

monthly_spendinteger

How much revenue the company generates for your business.

session_countinteger

How many sessions the company has recorded.

user_countinteger

The number of users in the company.

custom_attributesobject

The custom attributes you have set on the company.

Example response

{
  "type": "company",
  "id": "531ee472cce572a6ec000006",
  "name": "Blue Sun",
  "app_id": "ecahpwf5",
  "plan": {
    "type": "plan",
    "id": "269315",
    "name": "Pro"
  },
  "company_id": "6",
  "remote_created_at": 1663597223,
  "created_at": 1663597223,
  "updated_at": 1663597223,
  "last_request_at": 1663597223,
  "size": 100,
  "website": "https://www.intercom.com",
  "industry": "Software",
  "monthly_spend": 100,
  "session_count": 100,
  "user_count": 100,
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9
  },
  "tags": {
    "tags": [
      {
        "type": "tag",
        "id": "123456",
        "name": "Test tag"
      }
    ]
  },
  "segments": {
    "segments": [
      {
        "type": "segment",
        "id": "56203d253cba154d39010062",
        "name": "Active",
        "created_at": 1394621988,
        "updated_at": 1394622004,
        "person_type": "contact",
        "count": 3
      }
    ]
  }
}