Skip to main content
POST
Create canned response
Required scopes: canned_responses_write

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
text
string
required

The canned response text content. Sanitized on creation — if sanitization removes all content, the request is rejected as invalid.

tags
string[]
required

An array of tags.

group_id
integer
required

The ID of the group the canned response belongs to.

is_private
boolean

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

Response

200 - application/json

Canned response created successfully.

id
integer

The ID of the created canned response.