Canned responses

You can use the API to get or set canned response information.

The Canned respose model

Key

Type

Description

id

String

The unique identifier for the canned respose which is given by Tiledesk.

title

String

The canned respose title.

text

String

The canned respose content

attributes

Object

The custom attributes which are set for the canned respose.

createdAt

String

The time (ISO-8601 date string) when the canned respose was created.

updatedAt

String

The time (ISO-8601 date string) when the canned respose was updated.

createdBy

String

The unique identifier of the row creator

id_project

String

The unique identifier of the project

get
Get all canned responses

https://api.tiledesk.com/v2/:project_id/canned
Allows an account to list all the canned responses.
Request
Response
Request
Path Parameters
project_id
required
string
the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Query Parameters
sortField
optional
string
what field to sort the results by. Default field is createdAt
direction
optional
string
sort direction: 1 or -1. Return the results in ascending (1) or descending (-1) order. defaults to desc
page
optional
number
what page of results to fetch. defaults to first page.
Response
200: OK
[
{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
},
...
]

get
Get a canned respose by id

https://api.tiledesk.com/v2/:project_id/canned/:id
Request
Response
Request
Path Parameters
id
required
string
the canned identifier
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Response
200: OK
{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}

post
Create a new canned response

https://api.tiledesk.com/v2/:project_id/canned
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
title
optional
string
the canned response title
text
required
string
the canned response content
attributes
optional
object
The canned response custom attributes
Response
200: OK
{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}

put
Update a canned response by id

https://api.tiledesk.com/v2/:project_id/canned/:id
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
id
required
string
The id is the canned response indentifier.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
title
optional
string
the canned response title
text
required
string
the canned response content
attributes
optional
object
The canned response custom attributes
Response
200: OK
{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}

delete
Delete a canned response by id

https://api.tiledesk.com/v2/:project_id/canned/:id
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
id
required
string
The id is the canned response indentifier.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}