All the endpoints that can be called on the User controller.
Endpoints that require the USER_READ permission:
GET index
GET settings
Endpoints that require the API_RESERVE_USER permission:
POST reserveUserForLiveChannel
Endpoints that require the USER_ANONYMOUS_BROWSING_UPDATE permission:
PUT ticketIncognitoMode
All other endpoints require the USER_CUD permission.
Returns all the users.
This accepts a username, phone number or email address.
""Pattern: ^([0-9a-zA-Z \+]+)|([A-Za-z0-9._+\-\']+@[A-Za-z0-9.\-]+\.[A-Za-z]{2,})$015falsetrueGET /api/v2/user HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
No content
Returns the selected views of this user.
UID""Pattern: ^[0-9a-zA-Z \-\_]+$015GET /api/v2/user/getUserViews HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
No content
Creates a new user.
^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$The username of this user.
^[a-zA-Z0-9\.\-]+$^\+[0-9]+$enPossible values: en_GBPattern: ^([a-z]{2}_[A-Z]{2})|(iso)$[]truePOST /api/v2/user HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 179
{
"firstname": "text",
"lastname": "text",
"name": "text",
"email": "name@gmail.com",
"telephone_number": "text",
"language": "en",
"dateFormat": "en_GB",
"groups": [
1
],
"sendActivationMail": true
}No content
Updates the user's data.
Leaving any parameter empty will submit it as such. If you don't want to change a property, do not include it at all.
^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$The username of this user.
^[a-zA-Z0-9\.\-]+$^\+[0-9]+$^([a-z]{2}_[A-Z]{2})|(iso)$PUT /api/v2/user/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 145
"firstname='text'&lastname='text'&name='text'&email='name@gmail.com'&telephone='text'&language='nl'&dateFormat='text'&groups=[1]"No content
Updates the selected views for this user.
UIDPUT /api/v2/user/updateUserView HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40
"userID='UID'&viewID=1&newValue=1"No content
Updates the maximum chats for this user.
UIDPUT /api/v2/user/maxChats HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 29
"userID='UID'&maxChats=1"No content
Updates the chat sound on or off for this user.
UIDPUT /api/v2/user/chatSoundNewMessage HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 26
"userID='UID'&state=1"No content
Sets the setting to notify the user on ticket assignment on or off for this user.
UIDPUT /api/v2/user/notifyOnTicketAssignment HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 26
"userID='UID'&state=1"No content
Adds user statistic KPI.
UID^[a-zA-Z\_]+$""Pattern: ^[0-9a-zA-Z]+$""Pattern: ^[0-9a-zA-Z]+$POST /api/v2/user/userStatistic HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 86
{
"userID": "UID",
"statistic": "text",
"statisticOption": "",
"statisticSecondaryOption": ""
}No content
Deletes user statistic settings.
UID^[a-zA-Z\_]+$""Pattern: ^[0-9a-zA-Z]+$""Pattern: ^[0-9a-zA-Z]+$DELETE /api/v2/user/userStatistic HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 93
"userID='UID'&statistic='text'&statisticPrimaryOption=''&statisticSecondaryOption=''"No content
Updates this user's statistics watch setting.
UID^[a-zA-Z\_]+$""Pattern: ^[0-9a-zA-Z]+$""Pattern: ^[0-9a-zA-Z]+$PUT /api/v2/user/watch HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 115
"userID='UID'&statistic='text'&statisticPrimaryOption=''&statisticSecondaryOption=''&watchToggle='watch'"No content
Invokes a refresh on this tab.
^[a-zA-Z0-9\_]+$POST /api/v2/user/refreshTab HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 16
{
"tabID": "text"
}No content
Updates this user's status.
0POST /api/v2/user/updateStatus HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 107
{
"userID": 1,
"userEmailAddress": "name@gmail.com",
"statusID": 1,
"lastInternalCallID": 1,
"browserRequestTime": 0
}No content
Updates this user's incognito mode on tickets.
UIDPUT /api/v2/user/ticketIncognitoMode HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 26
"userID='UID'&state=1"No content
Updates this user's setting on automatically answering calls.
UIDPUT /api/v2/user/callsAutoAnswer HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 26
"userID='UID'&state=1"No content
Sets this user's active or inactive campaigns.
UIDName of the campaign you want to set the user's status to.
^[a-zA-z0-9\-_]+$POST /api/v2/user/userCampaignState HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 44
{
"userID": "UID",
"campaign": "text",
"state": 1
}No content
Sets this user to a specific status and locks it.
POST /api/v2/user/statusLock HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 23
{
"userID": 1,
"status": 1
}No content
Deletes the status lock on this user.
POST /api/v2/user/statusLockDelete HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 12
{
"userID": 1
}No content
Updates this user's username.
^[a-zA-Z0-9\.\-]+$PUT /api/v2/user/usernameUpdate HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 26
"id=1&username='text'"No content
Updates this user's first name.
^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$PUT /api/v2/user/firstnameUpdate HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 27
"id=1&firstname='text'"No content
Updates this user's last name.
^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$PUT /api/v2/user/lastnameUpdate HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 26
"id=1&lastname='text'"No content