Skip to main content
PATCH
Update a company

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

companyId
integer
required

The id returned when the company was listed. A company of another account answers 404, the same as an id that does not exist.

Example:

314

Body

application/json
company
object
required

At least one of the three fields. Whatever you omit is left as it is. domain and labels are not editable here: sending them equal to the current values is accepted and ignored, while a different value answers 400 and nothing is saved.

Response

Updated, with the values now stored.

A company of the account.

id
integer
required

The company id. Send it as companyId or company_id to the other company operations.

Example:

314

name
string
required

The company name.

Example:

"Transportadora Rápida"

domain
string | null
required

The company's web domain, null when it has none. Read-only through this API.

Example:

"rapida.com.br"

description
string | null
required

Free text about the company, null when it has none.

Example:

"Transportadora parceira para entregas no Sudeste."

contacts_count
integer
required

How many contacts are linked to the company.

Example:

3

labels
string[]
required

The labels on the company, by name. An empty array when it has none.

Example:
custom_attributes
object
required

The company's custom attributes, keyed by attribute key. A value is a string, a number, a boolean or an array of strings (for a multi-select list). An attribute your role cannot see is left out entirely, not returned as null, so a missing key can mean either "not set" or "not visible to you". An empty object when none are set.

Example:
created_at
string<date-time>
required

When the company was created. ISO 8601 in UTC, with milliseconds.

Example:

"2026-08-14T12:30:05.412Z"

updated_at
string<date-time>
required

When the company was last changed, in the same format.

Example:

"2026-10-28T17:02:41.903Z"