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.

Label Data Model

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

Headers

TODO

Example

curl -v -X GET -H 'Content-Type: application/json' -u andrea.leo@f21.it: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

Headers

TODO

Example

curl -v -X GET -H 'Content-Type: application/json' -u andrea.leo@f21.it: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

Headers

Request Body

TODO

Example:

curl -v -X POST -H 'Content-Type: application/json' -u andrea.leo@f21.it: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

Headers

TODO

Example:

curl -v -X PATCH -H 'Content-Type: application/json' -u andrea.leo@f21.it: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

Headers

TODO

Example:

curl -v -X DELETE -H 'Content-Type: application/json' -u andrea.leo@f21.it: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

Headers

TODO

Example:

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

Get all predefined labels

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

Path Parameters

Headers

TODO

Example

curl -v -X GET -H 'Content-Type: application/json' -u andrea.leo@f21.it: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

Headers

TODO

Example

curl -v -X GET -H 'Content-Type: application/json' -u andrea.leo@f21.it: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

Headers

TODO

Example

curl -v -X GET -H 'Content-Type: application/json' -u andrea.leo@f21.it: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

Headers

Request Body

TODO

Example:

curl -v -X POST -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/labels/default/clone

Last updated