Skip to main content
PATCH
Update a canned response

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

cannedResponseId
integer
required

The id returned when the canned response was created or listed.

Example:

42

Body

application/json
canned_response
object
required

At least one of the two fields. Whatever you omit is left as it is.

Response

Updated, with the values now stored.

id
integer
required

Stable identifier, unique within the instance.

Example:

42

short_code
string
required

The shortcut an agent types to expand this response. Unique within the account.

Example:

"refund-policy"

content
string
required

The text that gets inserted.

Example:

"Refunds are processed within 5 business days of approval."

created_at
string<date-time>
required

When it was created. ISO 8601, always UTC, milliseconds included.

Example:

"2026-08-13T19:09:51.482Z"

updated_at
string<date-time>
required

When it last changed, in the same format. Equal to created_at until the first edit. Changes made in the Cloud Chat interface move it too, so it is the field to poll if you mirror canned responses somewhere else.

Example:

"2026-08-13T19:42:07.115Z"