Create a Canned Response
Create a new canned response.
HTTP Method | URL | Requires Auth |
---|---|---|
|
|
Permissions required:
save-canned-responses
save-all-canned-responses
Body Parameters
Key | Example Value | Description |
---|---|---|
|
| The shortcut to trigger the message snippet. |
|
| The message snippet. |
|
| The scope of the canned response. It can either be |
|
| The tags for your canned response. |
|
| The |
Example Call
Example Response
Success
Error
Any of the following errors can occur on the endpoint.
Authorization: Requires an authentication token for the request to be made.
No Permission: Occurs when the authenticated user doesn't have the
save-canned-responses
andsave-all-canned-responses
permission.Invalid Department: If the
scope
of the canned response isdepartment
, a validdepartmentId
is required to specify the department it belongs to. This error occurs when there is no validdepartmentId
in the body of the request.Shortcut Exists: The
shortcut
value of the canned response must be unique. This error occurs when the shortcut already exists.
Change Log
Version | Description |
---|---|
1.0.0 | Added |
Last updated