Update company
Companies
Update company
PATCH /companies/ — update fields on an active object
PATCH
Update company
Endpoint
/companies/{companyId}Authentication: Bearer JWT Path parameter:
companyId — object ID
Query parameters
Comma-separated list of additional property names to include alongside the default set for this object type (e.g.
?properties=phone). Names already in the default set are not duplicated. Invalid or disallowed property names return 400.Request body
The body is a JSON object with a singlefields property. Each key inside fields is a field internal_name (the same names returned in GET responses, not nested under fields in the response).
Only include keys you want to change. Omitted fields keep their current values.
Custom fields configured in your account use the same key names inside
fields.
Default response fields
200 returns the updated object using the default property set:created_at and updated_at are always included in every response (ISO 8601 UTC), even when not listed above. When an object is archived, archived_by is also included automatically.Errors
Authorizations
Bearer JWT with valid account context.
Path Parameters
Object identifier
Query Parameters
Comma-separated additional property names to include alongside defaults (e.g. phone). Invalid or disallowed names return 400.
Body
application/json
Write payload for POST create and PATCH update. Keys inside fields match field internal names returned in GET responses.
Field values keyed by internal_name. Custom account fields use the same key names.
Response
Updated
Assigned owner email
Example:
"jane@example.com"
false when active, or ISO timestamp when archived
