A user represents an agent and can be assigned to many departments.

{
  "id": "aca76a89-8950-4424-b727-2f277c24a891",
  "type": "AGENT",
  "gender": "Male",
  "UserName": "[email protected]",
  "culture": "en-US",
  "isAnonymous": true,
  "uniqueArgument": "johnsCustomArgument",
  "fullName": "Jhon Wick",
  "shortName": "Jhon",
  "jobTitle": "Vacation Agent",
  "status": "Offline",
  "roles": [
    "SystemUser",
    "WhatsApp"
  ]
}

Parameter
Type
Description
Allowed Values
id string The Id of the user.
gender string The gender of the user. Undefined, Male, Female
UserName string Users' email.
culture string Affects the user's GUI. en-US, es-ES, he-IL
isAnonymous boolean If true, the user is excluded from statistics.
uniqueArgument string Custom argument, like the userId in your CRM.
type string The type of the user. AGENT is the standard type, for a human agent.
Tickets assigned to BOT will not send any automatic messages from our platform.
BOT and API users can't login into our platform, they can only use the REST API.
AGENT, BOT, API
fullName string Full name of the user. This value is not exposed to customers.
shortName string First name of the user. This value is exposed to customers.
jobTitle string Exposed in mail signatures.
status string The status of the user. Offline, Break, Online
roles array
[string]
MasterUser, DepartmentAdmin, SystemUser, ReadOnly, DataControler, EmailSession, webChat, FaceBookMessenger, FaceBookPosts, SMSchat, WhatsApp, InstagramFeed, PhoneCall, InstagramDM, Viber, AppleBusinessChat