All the endpoints that can be called on the User controller.
Endpoints that require the USER_READ permission:
Endpoints that require the API_RESERVE_USER permission:
POST reserveUserForLiveChannel
Endpoints that require the USER_ANONYMOUS_BROWSING_UPDATE permission:
All other endpoints require the USER_CUD permission.
index
get
querystring · min: 1OptionalThis 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,})$ itemStartnumberOptionalDefault: 0
itemLimitnumber · max: 999OptionalDefault: 15
activeOnlybooleanOptionalDefault: false
extendedbooleanOptionalDefault: true
index
post
Body
firstnamestring · min: 1RequiredPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
lastnamestring · min: 1RequiredPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
namestring · min: 2RequiredThe username of this user.
^[a-zA-Z0-9\.\-]+$ emailstring · email · min: 1Required
telephone_numberstring · min: 12 · max: 12RequiredPattern: ^\+[0-9]+$
languagestring · enumOptionalDefault: enPossible values:
dateFormatstring · min: 3 · max: 5OptionalDefault: en_GBPattern: ^([a-z]{2}_[A-Z]{2})|(iso)$
groupsnumber[]OptionalDefault: []
sendActivationMailbooleanOptionalDefault: true
settings
get
Returns all the settings for this user.
userIDnumberOptionalDefault: UID
item
put
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.
Body
firstnamestring · min: 1OptionalPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
lastnamestring · min: 1OptionalPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
namestring · min: 2OptionalThe username of this user.
^[a-zA-Z0-9\.\-]+$ emailstring · email · min: 1Optional
telephonestring · min: 12 · max: 12OptionalPattern: ^\+[0-9]+$
languagestring · enumOptionalPossible values:
dateFormatstring · min: 3 · max: 5OptionalPattern: ^([a-z]{2}_[A-Z]{2})|(iso)$
item
delete
Deletes this user by their ID.
activate
put
Activates this user in the database.
Body
deactivate
put
Deactivates this user in the database.
Body
getUserViews
get
Returns the selected views of this user.
userIDnumberOptionalDefault: UID
querystring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z \-\_]+$
itemStartnumberOptionalDefault: 0
itemLimitnumber · max: 9999OptionalDefault: 15
updateUserView
put
Updates the selected views for this user.
Body
userIDnumberOptionalDefault: UID
newValuenumber · max: 1Required
maxChats
put
Updates the maximum chats for this user.
Body
userIDnumberOptionalDefault: UID
chatSoundNewMessage
put
Updates the chat sound on or off for this user.
Body
userIDnumberOptionalDefault: UID
statenumber · max: 1Required
notifyOnTicketAssignment
put
Sets the setting to notify the user on ticket assignment on or off for this user.
Body
userIDnumberOptionalDefault: UID
statenumber · max: 1Required
userStatistic
get
Returns this user's statistics.
userIDnumberOptionalDefault: UID
userStatistic
post
Body
userIDnumberOptionalDefault: UID
statisticstring · min: 1RequiredPattern: ^[a-zA-Z\_]+$
statisticOptionstring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z]+$
statisticSecondaryOptionstring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z]+$
userStatistic
delete
Deletes user statistic settings.
Body
userIDnumberOptionalDefault: UID
statisticstring · min: 1RequiredPattern: ^[a-zA-Z\_]+$
statisticPrimaryOptionstring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z]+$
statisticSecondaryOptionstring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z]+$
watch
put
Updates this user's statistics watch setting.
Body
userIDnumberOptionalDefault: UID
statisticstring · min: 1RequiredPattern: ^[a-zA-Z\_]+$
statisticPrimaryOptionstring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z]+$
statisticSecondaryOptionstring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z]+$
watchTogglestring · enumRequiredPossible values:
refreshTab
post
Invokes a refresh on this tab.
Body
tabIDstring · min: 1RequiredPattern: ^[a-zA-Z0-9\_]+$
updateStatus
post
Updates this user's status.
Body
userEmailAddressstring · email · min: 1Required
lastInternalCallIDnumberOptional
browserRequestTimenumberOptionalDefault: 0
ticketIncognitoMode
put
Updates this user's incognito mode on tickets.
Body
userIDnumberOptionalDefault: UID
statenumber · max: 1Required
callsAutoAnswer
put
Updates this user's setting on automatically answering calls.
Body
userIDnumberOptionalDefault: UID
statenumber · max: 1Required
userCampaignState
post
Sets this user's active or inactive campaigns.
Body
userIDnumberOptionalDefault: UID
campaignstring · min: 1RequiredName of the campaign you want to set the user's status to.
^[a-zA-z0-9\-_]+$ statenumber · max: 1Required
statusLock
post
Sets this user to a specific status and locks it.
Body
statusLockDelete
post
Deletes the status lock on this user.
Body
userDashboard
get
Returns this user's dashboard data.
E.g. name, ID and avatar.
userIDnumberOptionalDefault: UID
userActivationLink
get
Sends this user an account activation link.
usernameUpdate
put
Updates this user's username.
Body
usernamestring · min: 2RequiredPattern: ^[a-zA-Z0-9\.\-]+$
firstnameUpdate
put
Updates this user's first name.
Body
firstnamestring · min: 1RequiredPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
lastnameUpdate
put
Updates this user's last name.
Body
lastnamestring · min: 1RequiredPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
Last updated
