Body fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Company name |
website | string | no | Company website URL |
industry | string | no | Industry or sector |
numbers | string[] | no | Phone numbers, normalized to E.164. An invalid number returns 400 INVALID_REQUEST_BODY |
custom_attributes | object | no | Values of your company attributes, keyed by attribute key |
Custom attributes
custom_attributes sets the values of your company attributes. Create the attribute first, then use its key here.
| Attribute type | Accepted value |
|---|---|
TEXT | A string |
NUMBER | A finite JSON number. Strings are rejected. Read back as a decimal, so 180 is returned as 180.0 |
BOOLEAN | A JSON boolean |
DATE | YYYY-MM-DD or an ISO datetime. Stored as a date and returned as YYYY-MM-DD |
DROPDOWN | An option key or label, case-insensitive. Always returned as the option key |
- Send
nullfor a key to clear its value. - Keys you leave out are not changed.
{}, or leaving outcustom_attributes, changes nothing. - An unknown or archived key returns
400 CUSTOM_ATTRIBUTE_KEY_UNKNOWN. A value of the wrong type returns400 CUSTOM_ATTRIBUTE_VALUE_INVALID. In both casesparamiscustom_attributes.<key>. - The whole request is validated before anything is written, so a rejected request creates 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
The DROPDOWN label Advanced is stored and returned as its key advanced. Other company fields are omitted from the response below.
{
"name": "Acme Corp",
"custom_attributes": {
"ping_pong_level": "Advanced",
"renewal_date": "2026-12-01"
}
}
{
"data": {
"id": "com-xyz789",
"name": "Acme Corp",
"custom_attributes": {
"ping_pong_level": "advanced",
"renewal_date": "2026-12-01"
}
}
}