Departments
The Department model
Key | Type | Description |
---|---|---|
id | String | The unique identifier for the department which is given by Tiledesk. |
name | String | The department name. |
id_bot | Array | The bot identifier associated to the department |
routing | String | The department routing type. Permitted values: 'assigned', 'pooled' |
id_group | String | The group identifier associated to the department |
default | Boolean | Determines if it is the default department |
status | Number | The request status: VISIBLE : 1, INVISIBLE : 0 |
attributes | Object | The custom attributes which are set for the department. |
createdAt | String | The time when the department was created. |
updatedAt | String | The time when the department was updated. |
createdBy | String | The unique identifier of the row creator |
id_project | String | The unique identifier of the project |
Get all active departments
GET
https://api.tiledesk.com/v3/:project_id/departments
Allows an account to list all the active departments 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 |
Example
Get all departments (active or hidden)
GET
https://api.tiledesk.com/v3/:project_id/departments/allstatus
Allows an account to list all the departments 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 |
Example
Get a department by id
GET
https://api.tiledesk.com/v3/:project_id/departments
Allows an account to get a department 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. |
id | string | The department identifier |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | authorization token. Basic Auth or JWT |
Example
Create a new department
POST
https://api.tiledesk.com/v3/:project_id/departments
Allows to add more departments.
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 |
---|---|---|
name | string | The department name |
routing | string | Optional. The department routing type. Permitted values: 'assigned', 'pooled' (default) |
id_group | string | Optional. The group of users assigned to the department. If not provided the request will be routed through all available users. |
id_bot | string | Optional. The bot assigned to the department, if any. |
Example:
Update a department
PUT
https://api.tiledesk.com/v3/:project_id/departments/:id
Allows to update a department.
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 department 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 |
---|---|---|
name | string | The department name |
routing | string | Optional. The department routing type. Permitted values: 'assigned', 'pooled' (default) |
id_group | string | Optional. The group of users assigned to the department. If not provided the request will be routed through all available users. |
id_bot | string | Optional. The bot assigned to the department, if any. |
Example:
Delete a department
DELETE
https://api.tiledesk.com/v3/:project_id/departments/:id
Allows to delete a department.
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 department identifier |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | authorization token. Basic Auth or JWT |
Example:
Last updated