Skip to main content
PATCH
Update a label

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

labelId
integer
required

The label id returned by List labels, Get a label or Create a label. It is the label's id, not its title.

Example:

14

Body

application/json

The changes go under a label wrapper. Administrator or CX engineer only. At least one of the four fields must be present; what is not sent stays untouched.

label
object
required

Response

The label as stored. A title change is applied to the label right away; the retag of the records that carried the old title runs after this answer.

A label definition of the account — the tag conversations and contacts carry.

id
integer
required
Example:

14

title
string | null
required

The label text, exactly as it appears in the dashboard and in Conversation.labels.

Example:

"vip"

description
string | null
required
Example:

"High-value customers."

color
string
required

Hex color the dashboard renders the label chip in.

Example:

"#5C6BC0"

show_on_sidebar
boolean
required

Whether the label appears in the dashboard's conversation sidebar filter.

Example:

true

created_at
string<date-time>
required
Example:

"2026-05-02T11:04:17.000Z"

updated_at
string<date-time>
required
Example:

"2026-08-10T14:32:05.123Z"