Faq

The Faq model

Key

Type

Description

id

String

The unique identifier for the faq which is given by Tiledesk.

question

String

The faq question.

answer

String

The faq answer

language

String

The faq language

topic

String

The faq topic

id_faq_kb

String

The bot identifier of the faq

attributes

Object

The custom attributes which are set for the faq.

createdAt

String

The time when the faq was created.

updatedAt

String

The time when the faq was updated.

createdBy

String

The unique identifier of the row creator

id_project

String

The unique identifier of the project

get
Get all faqs of a bot

https://api.tiledesk.com/v2/:project_id/faq
Allows an account to list all the faqs of the bot.
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
id_faq_kb
required
string
the bot id
Response
200: OK

Example

curl -v -X GET -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/faq?id_faq_kb=5be9b2ecc72a050015e14951

get
Get a faq by id

https://api.tiledesk.com/v2/:project_id/faq/
Allows an account to get a faq of a bot.
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 faq identifier
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK

Example

curl -v -X GET -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/faq/5be9b2ecc72a050015e14951

post
Create a new faq

https://api.tiledesk.com/v2/:project_id/faq
Allows to add more faqs.
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
id_faq_kb
required
string
The bot id
question
required
string
The faq question
answer
required
string
The faq answer
topic
optional
string
The faq topic
Response
200: OK

Example:

curl -v -X POST -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 -d '{"id_faq_kb":"123321", "question":"question", "answer":"answer"}' https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/faq

put
Update a faq

https://api.tiledesk.com/v2/:project_id/faq/:id
Allows to update a faq.
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 faq identifier
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
id_faq_kb
required
string
The bot id
question
required
string
The faq question
answer
required
string
The faq answer
topic
optional
string
The faq topic
Response
200: OK

Example:

curl -v -X PUT -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 -d '{"name":"bot1"}' https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/faq/5be9b2ecc72a050015e14951

delete
Delete a faq

https://api.tiledesk.com/v2/:project_id/faq/:id
Allows to delete a faq.
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 bot identifier
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK

Example:

curl -v -X DELETE -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/faq/5be9b2ecc72a050015e14951