Labels

Labels

You can use the API to get or set label information.

The Model

The API tag is used to implement internationalization and multilingual for the widget and chatbots.

Key	Type	Description
id	String	The unique identifier for the label which is given by Tiledesk.
data	Object	The label data model.
attributes	Object	The custom attributes which are set for the label.
createdAt	String	The time (ISO-8601 date string) when the label was created.
updatedAt	String	The time (ISO-8601 date string) when the label was updated.
createdBy	String	The unique identifier of the row creator
id_project	String	The unique identifier of the project

Label Data Model

Key	Type	Description
lang	String	The language identifier
data	Object	The translation labels data
category	String	The label data category
default	Boolean	Determines if this translation is the default for the project.

Get all labels for the project_id

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

Allows an account to list all the labels.

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

200

TODO

Example

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

Get a all the labels for the provided language

GET https://api.tiledesk.com/v3/:project_id/labels/:id

Fetches the labels by the provided language

Path Parameters

Name	Type	Description
id	string	the language iso identifier(Ex. EN, IT, ES, etc.)
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

200

TODO

Example

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

Create or update a label

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

Allows to add or update labels.

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
lang	string	the language identifier
data	object	the data object
default	boolean	Dermine if this is the default language

200

TODO

Example:

curl -v -X POST -H 'Content-Type: application/json' -u [e-mail]:123456  -d '{"lang":"andrea", "data":{OBJECT}}' https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/labels

Make a language as default for the project

PATCH https://api.tiledesk.com/v3/:project_id/labels/:lang/default

Make a language as default for the project

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
lang	string	The language identifier

Headers

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

200

TODO

Example:

curl -v -X PATCH -H 'Content-Type: application/json' -u [e-mail]:123456   https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/labels/EN/default

Delete a label by language identifier

DELETE https://api.tiledesk.com/v3/:project_id/labels/:lang

Allows to delete a label by language identifier.

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
lang	string	The lang indentifier.

Headers

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

200

TODO

Example:

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

Delete all the labels of the project

DELETE https://api.tiledesk.com/v3/:project_id/labels/

Allows to delete all the labels of the project

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

200

TODO

Example:

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

Get all predefined labels

GET https://api.tiledesk.com/v3/:project_id/labels/default

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

200

TODO

Example

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

Get all the standard pre-translated labels

GET https://api.tiledesk.com/v3/:project_id/labels/default

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

200

TODO

Example

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

Get the standard pre-translated label by language id

GET https://api.tiledesk.com/v3/:project_id/labels/default/lang

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

200

TODO

Example

curl -v -X GET -H 'Content-Type: application/json' -u [e-mail]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/labels/default/EN

Create a label clone from a pre-traslated language

POST https://api.tiledesk.com/v3/:project_id/labels/default/clone

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
lang	string	the language identifier

200

TODO

Example:

curl -v -X POST -H 'Content-Type: application/json' -u [e-mail]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/labels/default/clone