Allo

Update company

Updates an existing company. Only provided fields will be updated. Set custom attribute values with custom attributes . A key that is not an active company…

PUT/v2/api/crm/companies/{id}

Partial update

This endpoint performs a partial update -- only the fields you include in the request body are modified. Omitted fields are left unchanged.

All fields from the create endpoint are accepted and optional.

custom_attributes is accepted too. Only the keys you send change.

numbers replaces the company's phone numbers: a list sets the full set, [] removes them all, and omitting it leaves them unchanged. Numbers are normalized to E.164 and an invalid one returns 400 INVALID_REQUEST_BODY.

Custom attributes

custom_attributes sets the values of your company attributes. Create the attribute first, then use its key here.

Attribute typeAccepted value
TEXTA string
NUMBERA finite JSON number. Strings are rejected. Read back as a decimal, so 180 is returned as 180.0
BOOLEANA JSON boolean
DATEYYYY-MM-DD or an ISO datetime. Stored as a date and returned as YYYY-MM-DD
DROPDOWNAn option key or label, case-insensitive. Always returned as the option key
  • Send null for a key to clear its value.
  • Keys you leave out are not changed. {}, or leaving out custom_attributes, changes nothing.
  • An unknown or archived key returns 400 CUSTOM_ATTRIBUTE_KEY_UNKNOWN. A value of the wrong type returns 400 CUSTOM_ATTRIBUTE_VALUE_INVALID. In both cases param is custom_attributes.<key>.
  • The whole request is validated before anything is written, so a rejected request changes nothing.
  • The response always includes custom_attributes, {} when the company has none. Archived attributes and empty values are left out.
  • Values are also synced to your connected HubSpot and Attio. A value on an attribute that is synced from a CRM can be overwritten by the next CRM sync.
  • Teams on the legacy contact model get 404 TEAM_NOT_FOUND.

Example

This sets ping_pong_level and clears renewal_date. Any other custom attribute is untouched.

{
  "custom_attributes": {
    "ping_pong_level": "Advanced",
    "renewal_date": null
  }
}
{
  "data": {
    "id": "com-xyz789",
    "name": "Acme Corp",
    "custom_attributes": {
      "ping_pong_level": "advanced"
    }
  }
}

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

idstringrequired

Company ID (e.g., "com-xyz789")

Body

namestring | null

Company name

websitestring | null

Company website URL

industrystring | null

Industry sector

numbersstring[]

Phone numbers of the company. A list replaces all existing numbers (numbers you leave out are removed), [] removes them all, and omitting the field or sending null leaves them untouched. Each number is normalized to E.164 and duplicates are merged. An invalid number rejects the request with 400 INVALID_REQUEST_BODY, and the offending value is named in errors.

custom_attributesobject | null

Values for the company's custom attributes, keyed by attribute key. TEXT takes a string, NUMBER a finite JSON number (numeric strings are rejected), BOOLEAN a JSON boolean, DATE a YYYY-MM-DD string or ISO datetime, and DROPDOWN an option key or label (case-insensitive). Send null to clear a value; keys you omit are left untouched, and {} or omitting the field changes nothing. An unknown or archived key, or a value of the wrong type, rejects the whole request with CUSTOM_ATTRIBUTE_KEY_UNKNOWN or CUSTOM_ATTRIBUTE_VALUE_INVALID.

Responses

200Company updated
dataobject

A company in the CRM

11 fields
idstring

Unique company identifier

namestring

Company name

websitestring | null

Company website URL

industrystring | null

Industry sector

numbersstring[]

Phone numbers of the company, in E.164 format

person_countinteger

Number of people linked to this company

interactionsinteger

Total number of interactions across all people in this company

last_activity_atstring<date-time> | null

Timestamp of the last activity

created_atstring<date-time>

When the company was created

updated_atstring<date-time>

When the company was last updated

custom_attributesobject

Values of the company's custom attributes, keyed by attribute key. Always present, {} when there are none. Archived attributes and empty values are omitted. NUMBER values are decimals (180 is returned as 180.0), DATE values are YYYY-MM-DD and DROPDOWN values are the option key. Create the attributes first with POST /v2/api/crm/companies/attributes.

400
401
404
422
429