Skip to main content
POST
Update canned response
Required scopes: canned_responses--groups:rw,

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
id
integer
required

The ID of the canned response to update.

text
string

The updated canned response text. The API sanitizes the text and rejects the request as invalid if sanitization removes all content.

tags
string[]

An array of tags.

group_id
integer

The updated group ID for the canned response.

is_private
boolean

If set to true: makes the canned response private. If set to false: makes it public.

Response

200

Canned response updated successfully.