Skip to content
Home/
REST API Reference
/
/
Create Or Update Company...

Create Or Update Company Request Payload

You can create or update a Company. Send either company_id or id; a request with neither returns a 400 error.

namestring

The name of the Company. Leading and trailing whitespace is removed.

Example:"Intercom"
company_idstring

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

Example:"625e90fc55ab113b6d92175f"
idstring

An alternative name for company_id. Supply this or company_id.

Example:"625e90fc55ab113b6d92175f"
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

Values for custom attributes that already exist in your workspace. Each value can be a string, integer, number, boolean or null. Arrays and objects aren't accepted.

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

The time the company was created by you.

Example:1394531169
monthly_spendinteger

How much revenue the company generates for your business. Floats are truncated to whole integers, so 155.98 is stored as 155. A value above 2147483647 (2**31-1) is stored as 0. 2147483647 itself, or a value of -2147483648 or below, returns a 422 error.

Example:1000
update_last_request_atboolean

Set to true to update the company's last seen time to now.

Example:true
{
  "name": "Intercom",
  "company_id": "625e90fc55ab113b6d92175f",
  "id": "625e90fc55ab113b6d92175f",
  "plan": "Enterprise",
  "size": 100,
  "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,
  "update_last_request_at": true
}