Canned responses
The Canned response model
id (String) — The unique identifier for the canned response which is given by Tiledesk.
title (String) — The canned response title.
text (String) — The canned response content.
attributes (Object) — The custom attributes which are set for the canned response.
createdAt (String) — The time (ISO-8601 date string) when the canned response was created.
updatedAt (String) — The time (ISO-8601 date string) when the canned response was updated.
createdBy (String) — The unique identifier of the row creator.
id_project (String) — The unique identifier of the project.
Get all canned responses
GET https://api.tiledesk.com/v3/:project_id/canned
Allows an account to list all the canned responses.
Path parameters
project_id
string
The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Query parameters
sortField
string
What field to sort the results by. Default: createdAt
direction
string
Sort direction: 1 or -1. Return results in ascending (1) or descending (-1) order. Defaults to desc
page
number
What page of results to fetch. Defaults to first page.
Headers
Authorization
string
Authorization token. Basic Auth or JWT. Minimum role: agent
Example 200 response
Get a canned response by id
GET https://api.tiledesk.com/v3/:project_id/canned/:id
Path parameters
project_id
string
The project_id is a unique code assigned to your project when you create it in Tiledesk.
id
string
The canned response identifier.
Headers
Authorization
string
Authorization token. Basic Auth or JWT. Minimum role: agent
Content-Type
string
Use "application/json"
Example 200 response
Create a new canned response
POST https://api.tiledesk.com/v3/:project_id/canned
Path parameters
project_id
string
The project_id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization
string
Authorization token. Basic Auth or JWT. Minimum role: agent
Content-Type
string
Use "application/json"
Request body
title
string
The canned response title.
text
string
The canned response content.
attributes
object
The canned response custom attributes.
Example 200 response
Update a canned response by id
PUT https://api.tiledesk.com/v3/:project_id/canned/:id
Path parameters
project_id
string
The project_id is a unique code assigned to your project when you create it in Tiledesk.
id
string
The id is the canned response identifier.
Headers
Authorization
string
Authorization token. Basic Auth or JWT. Minimum role: agent
Content-Type
string
Use "application/json"
Request body
title
string
The canned response title.
text
string
The canned response content.
attributes
object
The canned response custom attributes.
Example 200 response
Delete a canned response by id
DELETE https://api.tiledesk.com/v3/:project_id/canned/:id
Path parameters
project_id
string
The project_id is a unique code assigned to your project when you create it in Tiledesk.
id
string
The id is the canned response identifier.
Headers
Authorization
string
Authorization token. Basic Auth or JWT. Minimum role: agent
Example 200 response
Related
Previous: Analytics — https://developer.tiledesk.com/apis/rest-api/analytics
Next: Tags — https://developer.tiledesk.com/apis/rest-api/tags
Last updated 2 years ago
Privacy: This site uses cookies to deliver its service and to analyze traffic. By browsing this site, you accept the privacy policy: https://tiledesk.com/privacy.html