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.
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
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
project_id (string) — the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Response
Example
Get 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
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
Authorization (string) — authorization token. Basic Auth or JWT
Content-Type (string) — use "application/json" value
Response
Example
Create or update a label
POST https://api.tiledesk.com/v3/:project_id/labels
Allows to add or update labels.
Path Parameters
project_id (string) — The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Content-Type (string) — use "application/json" value
Request Body
lang
string
the language identifier
data
object
the data object
default
boolean
Determine if this is the default language
Response
Example
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
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
Authorization (string) — authorization token. Basic Auth or JWT
Content-Type (string) — use "application/json" value
Response
Example
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
project_id (string) — The project_id is a unique code assigned to your project when you create it in Tiledesk
lang (string) — The lang identifier.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Response
Example
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
project_id (string) — The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Response
Example
Get all predefined labels
GET https://api.tiledesk.com/v3/:project_id/labels/default
Path Parameters
project_id (string) — the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Response
Example
Get all the standard pre-translated labels
GET https://api.tiledesk.com/v3/:project_id/labels/default
Path Parameters
project_id (string) — the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Response
Example
Get the standard pre-translated label by language id
GET https://api.tiledesk.com/v3/:project_id/labels/default/lang
Path Parameters
project_id (string) — the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Response
Example
Create a label clone from a pre-translated language
POST https://api.tiledesk.com/v3/:project_id/labels/default/clone
Path Parameters
project_id (string) — The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Content-Type (string) — use "application/json" value
Request Body
lang (string) — the language identifier
Response
Example
Last updated 2 years ago
This site uses cookies to deliver its service and to analyze traffic. By browsing this site, you accept the privacy policy: https://tiledesk.com/privacy.html