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

bot_only

Boolean

Determine if only the bot will reply to the visitor.

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
Get all active departments.

https://api.tiledesk.com/v2/:project_id/departments
Allows an account to list all the active departments of the project.
Request
Response
Request
Path Parameters
project_id
required
string
the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization
optional
string
authorization token. Basic Auth or JWT
Response
200: OK
[
{
"_id":"5b55e806c93dde00143163df",
"updatedAt":"2019-08-02T08:08:22.292Z",
"createdAt":"2018-07-23T14:36:54.410Z",
"name":"Default Department",
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5aaa99024c3b110014b478f0",
"online_msg":"Describe shortly your problem, you will be contacted by an agent..",
"offline_msg":"",
"__v":0,
"bot_only":false,
"id_bot":"5be9b2ecc72a050015e14951",
"status":1,
"default":true,
"routing":"assigned"
}
]

Example

curl -v -X GET https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/departments

get
Get all departments (active or hidden).

https://api.tiledesk.com/v2/:project_id/departments/allstatus
Allows an account to list all the departments of the project.
Request
Response
Request
Path Parameters
project_id
required
string
the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
[
{
"_id":"5b55e806c93dde00143163df",
"updatedAt":"2019-08-02T08:08:22.292Z",
"createdAt":"2018-07-23T14:36:54.410Z",
"name":"Default Department",
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5aaa99024c3b110014b478f0",
"online_msg":"Describe shortly your problem, you will be contacted by an agent..",
"offline_msg":"",
"__v":0,
"bot_only":false,
"id_bot":"5be9b2ecc72a050015e14951",
"status":1,
"default":true,
"routing":"assigned"
}
]

Example

curl -v -X GET -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/departments/allstatus

get
Get a department by id

https://api.tiledesk.com/v2/:project_id/departments
Allows an account to get a department of the project.
Request
Response
Request
Path Parameters
project_id
required
string
the Project Id is a unique code assigned to your project when you create it in Tiledesk.
id
required
string
The department identifier
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
{
"_id":"5b55e806c93dde00143163df",
"updatedAt":"2019-08-02T08:08:22.292Z",
"createdAt":"2018-07-23T14:36:54.410Z",
"name":"Default Department",
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5aaa99024c3b110014b478f0",
"online_msg":"Describe shortly your problem, you will be contacted by an agent..",
"offline_msg":"",
"__v":0,
"bot_only":false,
"id_bot":"5be9b2ecc72a050015e14951",
"status":1,
"default":true,
"routing":"assigned"
}

Example

curl -v -X GET -u andrea.leo@f21.it:123456 https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/departments/5b55e806c93dde00143163df

post
Create a new department

https://api.tiledesk.com/v2/:project_id/departments
Allows to add more departments.
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
name
required
string
The department name
routing
optional
string
The department routing type. Permitted values: 'assigned', 'pooled' (default)
id_group
optional
string
The group of users assigned to the department.
id_bot
optional
string
The bot assigned to the department.
bot_only
optional
boolean
Specify if the visitor can talk only with a bot or even with an agent. Default value: false
Response
200: OK
{
"_id":"5b55e806c93dde00143163df",
"updatedAt":"2019-08-02T08:08:22.292Z",
"createdAt":"2018-07-23T14:36:54.410Z",
"name":"Default Department",
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5aaa99024c3b110014b478f0",
"online_msg":"Describe shortly your problem, you will be contacted by an agent..",
"offline_msg":"",
"__v":0,
"bot_only":false,
"id_bot":"5be9b2ecc72a050015e14951",
"status":1,
"default":true,
"routing":"assigned"
}

Example:

curl -v -X POST -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 -d '{"name":"new department1", "routing":"pooled"}' https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/departments

put
Update a department

https://api.tiledesk.com/v2/:project_id/departments/:id
Allows to update a department.
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
id
required
string
The department identifier
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
name
required
string
The department name
routing
optional
string
The department routing type. Permitted values: 'assigned', 'pooled' (default)
id_group
optional
string
The group of users assigned to the department.
id_bot
optional
string
The bot assigned to the department.
bot_only
optional
boolean
Specify if the visitor can talk only with a bot or even with an agent. Default value: false
Response
200: OK
{
"_id":"5b55e806c93dde00143163df",
"updatedAt":"2019-08-02T08:08:22.292Z",
"createdAt":"2018-07-23T14:36:54.410Z",
"name":"Default Department",
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5aaa99024c3b110014b478f0",
"online_msg":"Describe shortly your problem, you will be contacted by an agent..",
"offline_msg":"",
"__v":0,
"bot_only":false,
"id_bot":"5be9b2ecc72a050015e14951",
"status":1,
"default":true,
"routing":"assigned"
}

Example:

curl -v -X PUT -H 'Content-Type: application/json' -u andrea.leo@f21.it:123456 -d '{"name":"new department1", "routing":"pooled"}' https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/departments/5b55e806c93dde00143163df

delete
Delete a department

https://api.tiledesk.com/v2/:project_id/departments/:id
Allows to delete a department.
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
id
required
string
The department identifier
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Response
200: OK
{
"_id":"5b55e806c93dde00143163df",
"updatedAt":"2019-08-02T08:08:22.292Z",
"createdAt":"2018-07-23T14:36:54.410Z",
"name":"Default Department",
"id_project":"5b55e806c93dde00143163dd",
"createdBy":"5aaa99024c3b110014b478f0",
"online_msg":"Describe shortly your problem, you will be contacted by an agent..",
"offline_msg":"",
"__v":0,
"bot_only":false,
"id_bot":"5be9b2ecc72a050015e14951",
"status":1,
"default":true,
"routing":"assigned"
}

Example:

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