Skip to main content
PATCH
Update an availability reason

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

availabilityReasonId
integer
required

The id returned when the availability reason was created or listed.

Example:

4

Body

application/json

The changes go under an availability_reason wrapper. Administrator only. At least one writable field must be present — an empty payload is a 400, not a no-op.

availability_reason
object
required

Response

The availability reason after the update.

A reason an agent can select when going busy. The account never chooses any availability besides busy for a reason created through this API — that field is not part of the public contract.

id
integer
required
Example:

4

reason
string
required
Example:

"Lunch"

emoji
string | null
required
Example:

"🍽️"

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"