> For the complete documentation index, see [llms.txt](https://docs.omnidesk.io/omnidesk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omnidesk.io/omnidesk/api-specification/user.md).

# User

**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

> \*\*Returns all the users.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user":{"get":{"tags":["User"],"summary":"index","description":"**Returns all the users.**","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## index

> \*\*Creates a new user.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user":{"post":{"tags":["User"],"summary":"index","description":"**Creates a new user.**","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"firstname":{"type":"string","description":"type: `^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$`"},"lastname":{"type":"string","description":"type: `^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$`"},"name":{"type":"string","description":"type: `^[a-zA-Z0-9\\.\\-]+$`"},"email":{"type":"string","description":"type: `string`\n\nMust be a valid email address format."},"telephone_number":{"type":"string","description":"type: `^\\+[0-9]+$`"},"language":{"type":"string","description":"type: `^(nl|en)$` = 'en'"},"dateFormat":{"type":"string","description":"type: `^([a-z]{2}_[A-Z]{2})|(iso)$` = 'en_GB"},"groups[]":{"type":"string","description":"type: `number` = null"},"sendActivationMail":{"type":"string","description":"type: `boolean` = true"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## settings

> \*\*Returns all the settings for this user.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/settings":{"get":{"tags":["User"],"summary":"settings","description":"**Returns all the settings for this user.**","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## item

> \*\*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.

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/{id}":{"put":{"tags":["User"],"summary":"item","description":"**Updates the user's data.**\n\nLeaving any parameter empty will submit it as such. If you don't want to change a property, do not include it at all.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"firstname":{"type":"string","description":"type: `^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$` = null\n\nInclude this parameter to overwrite the existing name."},"lastname":{"type":"string","description":"type: `^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$` = null\n\nInclude this parameter to overwrite the existing name."},"name":{"type":"string","description":"type: `^[a-zA-Z0-9\\.\\-]+$` = null"},"email":{"type":"string","description":"type: `string` = null\n\nMust be a valid email address format."},"telephone":{"type":"string","description":"type: `^\\+[0-9]+$` = null"},"language":{"type":"string","description":"type: `^en|nl$` = null"},"dateFormat":{"type":"string","description":"type: `^([a-z]{2}_[A-Z]{2})|(iso)$` = null"},"groups[]":{"type":"string","description":"type: `number` = null"}}}}}},"parameters":[{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## item

> \*\*Deletes this user by their ID.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/{id}":{"delete":{"tags":["User"],"summary":"item","description":"**Deletes this user by their ID.**","parameters":[{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## activate

> \*\*Activates this user in the database.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/activate":{"put":{"tags":["User"],"summary":"activate","description":"**Activates this user in the database.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"id":{"type":"string","description":"type: `number`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## deactivate

> \*\*Deactivates this user in the database.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/deactivate":{"put":{"tags":["User"],"summary":"deactivate","description":"**Deactivates this user in the database.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"id":{"type":"string","description":"type: `number`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## getUserViews

> \*\*Returns the selected views of this user.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/getUserViews":{"get":{"tags":["User"],"summary":"getUserViews","description":"**Returns the selected views of this user.**","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## updateUserView

> \*\*Updates the selected views for this user.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/updateUserView":{"put":{"tags":["User"],"summary":"updateUserView","description":"**Updates the selected views for this user.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"userID":{"type":"string","description":"type: `number` = UID"},"viewID":{"type":"string","description":"type: `number`"},"newValue":{"type":"string","description":"type: `[0|1]$`\n\nPut 1 if you want to add this view to the user, or 0 to unset."}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## maxChats

> \*\*Updates the maximum chats for this user.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/maxChats":{"put":{"tags":["User"],"summary":"maxChats","description":"**Updates the maximum chats for this user.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"userID":{"type":"string","description":"type: `number` = UID"},"maxChats":{"type":"string","description":"type: `number`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## chatSoundNewMessage

> \*\*Updates the chat sound on or off for this user.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/chatSoundNewMessage":{"put":{"tags":["User"],"summary":"chatSoundNewMessage","description":"**Updates the chat sound on or off for this user.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"userID":{"type":"string","description":"type: `number` = UID"},"state":{"type":"string","description":"type: `^[0,1]$`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## notifyOnTicketAssignment

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

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/notifyOnTicketAssignment":{"put":{"tags":["User"],"summary":"notifyOnTicketAssignment","description":"**Sets the setting to notify the user on ticket assignment on or off for this user.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"userID":{"type":"string","description":"type: `number` = UID"},"state":{"type":"string","description":"type: `^[0,1]$`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## userStatistic

> \*\*Returns this user's statistics.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/userStatistic":{"get":{"tags":["User"],"summary":"userStatistic","description":"**Returns this user's statistics.**","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## userStatistic

> \*\*Adds user statistic KPI.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/userStatistic":{"post":{"tags":["User"],"summary":"userStatistic","description":"**Adds user statistic KPI.**","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"userID":{"type":"string","description":"type: `number` = UID"},"statistic":{"type":"string","description":"type: `^[a-zA-Z\\_]+$`"},"statisticOption":{"type":"string","description":"type: `^[0-9a-zA-Z]+$` = ' '"},"statisticSecondaryOption":{"type":"string","description":"type: `^[0-9a-zA-Z]+$` = ' '"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## userStatistic

> \*\*Deletes user statistic settings.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/userStatistic":{"delete":{"tags":["User"],"summary":"userStatistic","description":"**Deletes user statistic settings.**","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## watch

> \*\*Updates this user's statistics watch setting.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/watch":{"put":{"tags":["User"],"summary":"watch","description":"**Updates this user's statistics watch setting.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"userID":{"type":"string","description":"type: `number` = UID"},"statistic":{"type":"string","description":"type: `^[a-zA-Z\\_]+$`"},"statisticPrimaryOption":{"type":"string","description":"type: `^[0-9a-zA-Z]+$` = ' '"},"statisticSecondaryOption":{"type":"string","description":"type: `^[0-9a-zA-Z]+$` = ' '"},"watchToggle":{"type":"string","description":"type: `^watch|unwatch$`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## refreshTab

> \*\*Invokes a refresh on this tab.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/refreshTab":{"post":{"tags":["User"],"summary":"refreshTab","description":"**Invokes a refresh on this tab.**","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"tabID":{"type":"string","description":"type: `^[a-zA-Z0-9\\_]+$`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## updateStatus

> \*\*Updates this user's status.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/updateStatus":{"post":{"tags":["User"],"summary":"updateStatus","description":"**Updates this user's status.**","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"userID":{"type":"string","description":"type: `number` = null"},"userEmailAddress":{"type":"string","description":"type: `string`\n\nMust be a valid email address format."},"statusID":{"type":"string","description":"type: `number`"},"lastInternalCallID":{"type":"string","description":"type: `number` = null"},"browserRequestTime":{"type":"string","description":"type: `number` = 0"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## ticketIncognitoMode

> \*\*Updates this user's incognito mode on tickets.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/ticketIncognitoMode":{"put":{"tags":["User"],"summary":"ticketIncognitoMode","description":"**Updates this user's incognito mode on tickets.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"userID":{"type":"string","description":"type: `number` = UID"},"state":{"type":"string","description":"type: `^[0,1]$`\n\nPut 1 for ticket incognito mode, 0 for regular."}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## callsAutoAnswer

> \*\*Updates this user's setting on automatically answering calls.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/callsAutoAnswer":{"put":{"tags":["User"],"summary":"callsAutoAnswer","description":"**Updates this user's setting on automatically answering calls.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"userID":{"type":"string","description":"type: `number` = UID"},"state":{"type":"string","description":"type: `^[0,1]$`\n\nPut 1 if you want auto-answer to be on, 0 if not."}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## userCampaignState

> \*\*Sets this user's active or inactive campaigns.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/userCampaignState":{"post":{"tags":["User"],"summary":"userCampaignState","description":"**Sets this user's active or inactive campaigns.**","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"userID":{"type":"string","description":"type: `number` = UID"},"campaign":{"type":"string","description":"type: `^[a-zA-z0-9\\-_]+$`\n\nName of the campagin you want to set the user's status to."},"state":{"type":"string","description":"type: `[0|1]$`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## statusLock

> \*\*Sets this user to a specific status and locks it.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/statusLock":{"post":{"tags":["User"],"summary":"statusLock","description":"**Sets this user to a specific status and locks it.**","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"userID":{"type":"string","description":"type: `number`"},"status":{"type":"string","description":"type: `number`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## statusLockDelete

> \*\*Deletes the status lock on this user.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/statusLockDelete":{"post":{"tags":["User"],"summary":"statusLockDelete","description":"**Deletes the status lock on this user.**","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"userID":{"type":"string","description":"type: `number`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## userDashboard

> \*\*Returns this user's dashboard data.\*\*\
> \
> E.g. name, ID and avatar.

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/userDashboard":{"get":{"tags":["User"],"summary":"userDashboard","description":"**Returns this user's dashboard data.**\n\nE.g. name, ID and avatar.","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## userActivationLink

> \*\*Sends this user an account activation link.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/userActivationLink":{"get":{"tags":["User"],"summary":"userActivationLink","description":"**Sends this user an account activation link.**","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## usernameUpdate

> \*\*Updates this user's username.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/usernameUpdate":{"put":{"tags":["User"],"summary":"usernameUpdate","description":"**Updates this user's username.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"id":{"type":"string","description":"type: `number`"},"username":{"type":"string","description":"type: `^[a-zA-Z0-9\\.\\-]+$`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## firstnameUpdate

> \*\*Updates this user's first name.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/firstnameUpdate":{"put":{"tags":["User"],"summary":"firstnameUpdate","description":"**Updates this user's first name.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"id":{"type":"string","description":"type: `number`"},"firstname":{"type":"string","description":"type: `^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## lastnameUpdate

> \*\*Updates this user's last name.\*\*

```json
{"openapi":"3.0.0","info":{"title":"Omnidesk API documentation","version":"1.0.0"},"tags":[{"name":"User","description":"**All the endpoints that can be called on the User controller.**\n\nEndpoints that require the `USER_READ` permission:\n\n- `GET` index\n    \n- `GET` settings\n    \n\nEndpoints that require the `API_RESERVE_USER` permission:\n\n- `POST` reserveUserForLiveChannel\n    \n\nEndpoints that require the `USER_ANONYMOUS_BROWSING_UPDATE` permission:\n\n- `PUT` ticketIncognitoMode\n    \n\nAll other endpoints require the `USER_CUD` permission."}],"servers":[{"url":"http://{{base_url}}"}],"security":[{"apikeyAuth":[]}],"components":{"securitySchemes":{"apikeyAuth":{"type":"http","scheme":"apikey"}}},"paths":{"/api/v2/user/lastnameUpdate":{"put":{"tags":["User"],"summary":"lastnameUpdate","description":"**Updates this user's last name.**","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"id":{"type":"string","description":"type: `number`"},"lastname":{"type":"string","description":"type: `^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$`"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```