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 new canned response text. Sanitized on update — if sanitization removes all content, the request is rejected as invalid.

tags
string[]

An array of tags.

group_id
integer

The new group ID for the canned response.

is_private
boolean

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

Response

200

Canned response updated successfully.