Links

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

Key
Type
Description
id
String
The unique identifier for the teammate which is given by Tiledesk.
role
String
The teammate role. Values: owner, agent, admin, user, guest
user_available
Boolean
Dermine if the teammate is available or unavailable to accept requests
id_user
Object
The user object referenced by the teammate
max_served_chat
Number
Number of chats that agent is allowed to take at one time (Only Enterprise)
number_assigned_requests
Number
Number of active request for the teammate (Only Enterprise)
isBusy
Boolean
Determine if the teammate is busy (Only Enterprise)
attributes
Object
The custom attributes which are set for the teammate.
tags
Array
A list of tags objects associated with the teammate.
settings
Object
The setting configurations of the teammate.
presence
Object
The presence info of the teammate.
isAuthenticated
Boolean
Returns true if is strongly authenticated (custom-auth or email/password), false otherwise (anonymous).
isBusy
Boolean
Returns true if is teammate is busy, false otherwise. See Tiledesk Smart Assignment for more info.
createdAt
String
The time (ISO-8601 date string) when the teammate was created.
updatedAt
String
The time (ISO-8601 date string) when the teammate was updated.
createdBy
String
The unique identifier of the row creator
id_project
String
The unique identifier of the project

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
https://api.tiledesk.com
/v2/:project_id/project_users
Get the team
get
https://api.tiledesk.com
/v2/:project_id/project_users/:project_user_id
Get a teammate by id
get
https://api.tiledesk.com
/v2/:project_id/project_users/users/:user_id
Get a teammate by user id
post
https://api.tiledesk.com
/v2/:project_id/project_users/invite
Invite an agent
put
https://api.tiledesk.com
/v2/:project_id/project_users/
Update the current logged teammate
put
https://api.tiledesk.com
/v2/:project_id/project_users/:project_user_id
Update a teammate by id
delete
https://api.tiledesk.com
/v2/:project_id/project_users/:project_user_id
Leave a project
Last modified 5mo ago