Tags
The Tag model
id (String) — The unique identifier for the tag which is given by Tiledesk.
tag (String) — The tag name.
color (String) — The tag hexadecimal color.
attributes (Object) — The custom attributes which are set for the tag.
createdAt (String) — The time (ISO-8601 date string) when the tag was created.
updatedAt (String) — The time (ISO-8601 date string) when the tag was updated.
createdBy (String) — The unique identifier of the row creator.
id_project (String) — The unique identifier of the project.
Get all tags GET https://api.tiledesk.com/v3/:project_id/tags
Allows an account to list all the tags.
Path parameters
project_id (string) — The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Query parameters
sortField (string) — what field to sort the results by. Default field is createdAt.
direction (string) — sort direction: 1 or -1. Return the results in ascending (1) or descending (-1) order. Defaults to desc.
page (number) — what page of results to fetch. Defaults to first page.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Success response (200)
Get a tag by id GET https://api.tiledesk.com/v3/:project_id/tags/:id
Path parameters
project_id (string) — The project_id assigned to your project when you create it in Tiledesk.
id (string) — the tag identifier.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Content-Type (string) — use "application/json" value
Success response (200)
Create a new tag POST https://api.tiledesk.com/v3/:project_id/tags
Path parameters
project_id (string) — The project_id 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
tag (string) — the tag name
color (string) — the tag color
attributes (object) — the tag custom attributes
Success response (200)
Update a tag by id PUT https://api.tiledesk.com/v3/:project_id/tags/:id
Path parameters
project_id (string) — The project_id assigned to your project when you create it in Tiledesk.
id (string) — The id is the tag identifier.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Content-Type (string) — use "application/json" value
Request body
tag (string) — the tag name
color (string) — the tag color
attributes (object) — the tag custom attributes
Success response (200)
Delete a tag by id DELETE https://api.tiledesk.com/v3/:project_id/tags/:id
Path parameters
project_id (string) — The project_id assigned to your project when you create it in Tiledesk.
id (string) — The id is the tag identifier.
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Success response (200)
Related
Canned responses: https://developer.tiledesk.com/apis/rest-api/canned-response
Events: https://developer.tiledesk.com/apis/rest-api/events
Original developer docs links referenced above:
Get all tags: https://developer.tiledesk.com/apis/rest-api/tags#get-all-tags
Get a tag by id: https://developer.tiledesk.com/apis/rest-api/tags#get-a-tag-by-id
Create a new tag: https://developer.tiledesk.com/apis/rest-api/tags#create-a-new-tag
Update a tag by id: https://developer.tiledesk.com/apis/rest-api/tags#update-a-tag-by-id
Delete a tag by id: https://developer.tiledesk.com/apis/rest-api/tags#delete-a-tag-by-id
Last updated 2 years ago.