omnidesk
  • Ticket
    • Message
    • Using forms
    • Contact forms
  • Customers
    • General
    • API sync on contact
    • CSV import
    • API sync before contact
    • Customer lookup
  • Telephone
    • Callflow
    • Numbers
  • E-mail
  • Users
  • Live chat
    • Livechat chatbot and app integration (backend)
  • Facebook
  • Twitter
  • Survey
    • Push data
  • Statistics
    • Statistics API
  • Raw data - BI
  • Security policy
  • Hosting
  • API docs
    • General
    • Authentication
    • REST
  • API specification
    • Documentation for the Omnidesk API endpoints
    • Chat
    • Customer
    • Email
    • Form
    • Formfield
    • Message
    • Notification
    • Raw
    • Ticket
    • User
    • View
    • Statisticsv2
Powered by GitBook
On this page
  1. API specification

User

PreviousTicketNextView

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.

index

get

Returns all the users.

Authorizations
Query parameters
querystring · min: 1Optional

This accepts a username, phone number or email address.

Default: ""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
Responses
200Success
get
GET /api/v2/user HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success

No content

settings

get

Returns all the settings for this user.

Authorizations
Query parameters
userIDnumberOptionalDefault: UID
Responses
200Success
get
GET /api/v2/user/settings HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success

No content

item

delete

Deletes this user by their ID.

Authorizations
Path parameters
idnumberRequired
Responses
200Success
delete
DELETE /api/v2/user/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success

No content

getUserViews

get

Returns the selected views of this user.

Authorizations
Query parameters
userIDnumberOptionalDefault: UID
querystring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z \-\_]+$
itemStartnumberOptionalDefault: 0
itemLimitnumber · max: 9999OptionalDefault: 15
Responses
200Success
get
GET /api/v2/user/getUserViews HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success

No content

userStatistic

get

Returns this user's statistics.

Authorizations
Query parameters
userIDnumberOptionalDefault: UID
Responses
200Success
get
GET /api/v2/user/userStatistic HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success

No content

userDashboard

get

Returns this user's dashboard data.

E.g. name, ID and avatar.

Authorizations
Query parameters
userIDnumberOptionalDefault: UID
Responses
200Success
get
GET /api/v2/user/userDashboard HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success

No content

userActivationLink

get

Sends this user an account activation link.

Authorizations
Query parameters
idnumberRequired
Responses
200Success
get
GET /api/v2/user/userActivationLink?id=1 HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success

No content

  • GETindex
  • POSTindex
  • GETsettings
  • PUTitem
  • DELETEitem
  • PUTactivate
  • PUTdeactivate
  • GETgetUserViews
  • PUTupdateUserView
  • PUTmaxChats
  • PUTchatSoundNewMessage
  • PUTnotifyOnTicketAssignment
  • GETuserStatistic
  • POSTuserStatistic
  • DELETEuserStatistic
  • PUTwatch
  • POSTrefreshTab
  • POSTupdateStatus
  • PUTticketIncognitoMode
  • PUTcallsAutoAnswer
  • POSTuserCampaignState
  • POSTstatusLock
  • POSTstatusLockDelete
  • GETuserDashboard
  • GETuserActivationLink
  • PUTusernameUpdate
  • PUTfirstnameUpdate
  • PUTlastnameUpdate

index

post

Creates a new user.

Authorizations
Body
firstnamestring · min: 1RequiredPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
lastnamestring · min: 1RequiredPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
namestring · min: 2Required

The username of this user.

Pattern: ^[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
Responses
200Success
post
POST /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
}
200Success

No content

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.

Authorizations
Path parameters
idnumberRequired
Body
firstnamestring · min: 1OptionalPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
lastnamestring · min: 1OptionalPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
namestring · min: 2Optional

The username of this user.

Pattern: ^[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)$
groupsnumber[]Optional
Responses
200Success
put
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]"
200Success

No content

activate

put

Activates this user in the database.

Authorizations
Body
idnumberRequired
Responses
200Success
put
PUT /api/v2/user/activate HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 8

"id=1"
200Success

No content

deactivate

put

Deactivates this user in the database.

Authorizations
Body
idnumberRequired
Responses
200Success
put
PUT /api/v2/user/deactivate HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 8

"id=1"
200Success

No content

updateUserView

put

Updates the selected views for this user.

Authorizations
Body
userIDnumberOptionalDefault: UID
viewIDnumberRequired
newValuenumber · max: 1Required
Responses
200Success
put
PUT /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"
200Success

No content

maxChats

put

Updates the maximum chats for this user.

Authorizations
Body
userIDnumberOptionalDefault: UID
maxChatsnumberRequired
Responses
200Success
put
PUT /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"
200Success

No content

chatSoundNewMessage

put

Updates the chat sound on or off for this user.

Authorizations
Body
userIDnumberOptionalDefault: UID
statenumber · max: 1Required
Responses
200Success
put
PUT /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"
200Success

No content

notifyOnTicketAssignment

put

Sets the setting to notify the user on ticket assignment on or off for this user.

Authorizations
Body
userIDnumberOptionalDefault: UID
statenumber · max: 1Required
Responses
200Success
put
PUT /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"
200Success

No content

userStatistic

post

Adds user statistic KPI.

Authorizations
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]+$
Responses
200Success
post
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": ""
}
200Success

No content

userStatistic

delete

Deletes user statistic settings.

Authorizations
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]+$
Responses
200Success
delete
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=''"
200Success

No content

watch

put

Updates this user's statistics watch setting.

Authorizations
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:
Responses
200Success
put
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'"
200Success

No content

refreshTab

post

Invokes a refresh on this tab.

Authorizations
Body
tabIDstring · min: 1RequiredPattern: ^[a-zA-Z0-9\_]+$
Responses
200Success
post
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"
}
200Success

No content

updateStatus

post

Updates this user's status.

Authorizations
Body
userIDnumberOptional
userEmailAddressstring · email · min: 1Required
statusIDnumberRequired
lastInternalCallIDnumberOptional
browserRequestTimenumberOptionalDefault: 0
Responses
200Success
post
POST /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
}
200Success

No content

ticketIncognitoMode

put

Updates this user's incognito mode on tickets.

Authorizations
Body
userIDnumberOptionalDefault: UID
statenumber · max: 1Required
Responses
200Success
put
PUT /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"
200Success

No content

callsAutoAnswer

put

Updates this user's setting on automatically answering calls.

Authorizations
Body
userIDnumberOptionalDefault: UID
statenumber · max: 1Required
Responses
200Success
put
PUT /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"
200Success

No content

userCampaignState

post

Sets this user's active or inactive campaigns.

Authorizations
Body
userIDnumberOptionalDefault: UID
campaignstring · min: 1Required

Name of the campaign you want to set the user's status to.

Pattern: ^[a-zA-z0-9\-_]+$
statenumber · max: 1Required
Responses
200Success
post
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
}
200Success

No content

statusLock

post

Sets this user to a specific status and locks it.

Authorizations
Body
userIDnumberRequired
statusnumberRequired
Responses
200Success
post
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
}
200Success

No content

statusLockDelete

post

Deletes the status lock on this user.

Authorizations
Body
userIDnumberRequired
Responses
200Success
post
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
}
200Success

No content

usernameUpdate

put

Updates this user's username.

Authorizations
Body
idnumberRequired
usernamestring · min: 2RequiredPattern: ^[a-zA-Z0-9\.\-]+$
Responses
200Success
put
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'"
200Success

No content

firstnameUpdate

put

Updates this user's first name.

Authorizations
Body
idnumberRequired
firstnamestring · min: 1RequiredPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
Responses
200Success
put
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'"
200Success

No content

lastnameUpdate

put

Updates this user's last name.

Authorizations
Body
idnumberRequired
lastnamestring · min: 1RequiredPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\- ]+$
Responses
200Success
put
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'"
200Success

No content