Team
A teammate is a special user who represents a Tiledesk user invited to a project with a specific role. When you work with teammates very often you will not use the user_id of the Tiledesk user but rather the specific id of your teammate in the project. In the Tiledesk API the temamate is named project_user. For example, if you want to know your project_user in a specific project, all you have to do is call this API: Get a teammate by id.
The Team Model
The Presence model
Presence lets you track the online and offline status of the teammates in real-time (if you use Tiledesk Websocket or Webhook) and store the information state. Possible values: online, offline. Attention: an agent passes from online to offline only when he closed all Tiledesk messaging apps (eg Agent web chat in all tabs and mobile apps).
Agent availability
The field user_available determines if the teammate is available or unavailable to accept requests. Attention: Agent availability changes only when the agent explicitly changes from the UI from available to unavailable. If an agent is available and logs out, the agent remains available as he may have decided to serve chats from another channel (eg. Tiledesk mobile app).
Get the team
GET
https://api.tiledesk.com/v3/:project_id/project_users
Return the team members and availability
Path Parameters
Headers
Get a teammate by id
GET
https://api.tiledesk.com/v3/:project_id/project_users/:project_user_id
Path Parameters
Headers
Get a teammate by user id
GET
https://api.tiledesk.com/v3/:project_id/project_users/users/:user_id
Path Parameters
Headers
Invite an agent
POST
https://api.tiledesk.com/v3/:project_id/project_users/invite
Invite an agent to a project.
Path Parameters
Headers
Request Body
Update the current logged teammate
PUT
https://api.tiledesk.com/v3/:project_id/project_users/
Path Parameters
Headers
Request Body
Update a teammate by id
PUT
https://api.tiledesk.com/v3/:project_id/project_users/:project_user_id
It requires admin role
Path Parameters
Headers
Request Body
Leave a project
DELETE
https://api.tiledesk.com/v3/:project_id/project_users/:project_user_id
Leave an agent from a project.
Path Parameters
Headers
Last updated