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
id_faq_kb	String	The bot identifier of the faq
language	String	The faq language with two-letter ISO 639-1 code.
intent_display_name	String	The intent display name. This is a unique indentifier of the faq
webhook_enabled	Boolean	Enable the webhook fullfillment endpoint for this intent
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
form	JSON	The form to fill out before continuing with intent execution
reply	JSON	The message reply to be sent
enabled	Boolean	If false the intent is not processed

Get all faqs of a bot

GET https://api.tiledesk.com/v3/:project_id/faq

Allows an account to list all the faqs of the bot.

Path Parameters

Name	Type	Description
project_id	string	the Project Id is a unique code assigned to your project when you create it in Tiledesk.

Query Parameters

Name	Type	Description
id_faq_kb	string	the bot id
intent_display_name	string	filter by intent_display_name field
page	number	page number for pagination
limit	number	set the limit parameter to ensure you know how many results per page you'll get
text	string	Use the text parameter to query the elements by a full text search

Headers

Name	Type	Description
Authorization	string	authorization token. Basic Auth or JWT

200

Example

curl -v -X GET -u [e-mail]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/faq?id_faq_kb=5be9b2ecc72a050015e14951

Get a faq by id

GET https://api.tiledesk.com/v3/:project_id/faq/

Allows an account to get a faq of a bot.

Path Parameters

Name	Type	Description
project_id	string	the Project Id is a unique code assigned to your project when you create it in Tiledesk.
id	string	The faq identifier

Headers

Name	Type	Description
Authorization	string	authorization token. Basic Auth or JWT

200

Example

curl -v -X GET -u [e-mail]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/faq/5be9b2ecc72a050015e14951

Create a new faq

POST https://api.tiledesk.com/v3/:project_id/faq

Allows to add more faqs.

Path Parameters

Name	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Tiledesk

Headers

Name	Type	Description
Authorization	string	authorization token. Basic Auth or JWT
Content-Type	string	use "application/json" value

Request Body

Name	Type	Description
id_faq_kb	string	The bot id
question	string	The faq question
answer	string	The faq answer
intent_display_name	string	The faq intent display name
language	string	The faq language with the two-letter ISO 639-1 language code format.
webhook_enabled	boolean	Enable the webhook fullfillment endpoint for this intent

200

Example:

curl -v -X POST -H 'Content-Type: application/json' -u [e-mail]:123456  -d '{"id_faq_kb":"123321", "question":"question", "answer":"answer"}' https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/faq

Update a faq

PUT https://api.tiledesk.com/v3/:project_id/faq/:id

Allows to update a faq.

Path Parameters

Name	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Tiledesk
id	string	The faq identifier

Headers

Name	Type	Description
Authorization	string	authorization token. Basic Auth or JWT
Content-Type	string	use "application/json" value

Request Body

Name	Type	Description
id_faq_kb	string	The bot id
question	string	The faq question
answer	string	The faq answer
intent_display_name	string	The faq intent display name
language	string	The faq language with the two-letter ISO 639-1 language code format
enabled	string	The faq status. Permitted values: true | false
reply	object	The reply object in JSON format
webhook_enabled	boolean	Enable the webhook fullfillment endpoint for this intent

200

Example:

curl -v -X PUT -H 'Content-Type: application/json' -u [e-mail]:123456  -d '{"name":"bot1"}' https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/faq/5be9b2ecc72a050015e14951

Delete a faq

DELETE https://api.tiledesk.com/v3/:project_id/faq/:id

Allows to delete a faq.

Path Parameters

Name	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Tiledesk
id	string	The bot identifier

Headers

Name	Type	Description
Authorization	string	authorization token. Basic Auth or JWT

200

Example:

curl -v -X DELETE -H 'Content-Type: application/json' -u [e-mail]:123456  https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/faq/5be9b2ecc72a050015e14951