Update Company Request Payload

Home/

REST API Reference

You can update a Company

namestring

The name of the Company

Example:"Intercom"

planstring

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

Example:"Enterprise"

sizeinteger

The number of employees in this company.

Example:"100"

websitestring

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

Example:"https://www.example.com"

industrystring

The industry that this company operates in.

Example:"Manufacturing"

custom_attributesobject

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

Example:

{
  "paid_subscriber": true,
  "monthly_spend": 155.5,
  "team_mates": 9
}

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:1000

{
  "name": "Intercom",
  "plan": "Enterprise",
  "size": "100",
  "website": "https://www.example.com",
  "industry": "Manufacturing",
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9
  },
  "monthly_spend": 1000
}