# 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.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}},"parameters":{"itemStart":{"name":"itemStart","in":"query","schema":{"type":"number","default":0}}}},"paths":{"/api/v2/user":{"get":{"tags":["User"],"summary":"index","description":"**Returns all the users.**","operationId":"userIndexGET","parameters":[{"name":"query","in":"query","description":"This accepts a username, phone number or email address.","schema":{"type":"string","pattern":"^([0-9a-zA-Z \\+]+)|([A-Za-z0-9._+\\-\\']+@[A-Za-z0-9.\\-]+\\.[A-Za-z]{2,})$","minLength":1,"default":""}},{"$ref":"#/components/parameters/itemStart"},{"name":"itemLimit","in":"query","schema":{"type":"number","maximum":999,"default":15}},{"name":"activeOnly","in":"query","schema":{"type":"boolean","default":false}},{"name":"extended","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":""}}}}}}
```

## index

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user":{"post":{"tags":["User"],"summary":"index","description":"**Creates a new user.**","operationId":"userIndexPOST","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["firstname","lastname","name","email","telephone_number"],"properties":{"firstname":{"type":"string","pattern":"^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$","minLength":1},"lastname":{"type":"string","pattern":"^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$","minLength":1},"name":{"description":"The username of this user.","type":"string","pattern":"^[a-zA-Z0-9\\.\\-]+$","minLength":2},"email":{"type":"string","format":"email","minLength":1},"telephone_number":{"type":"string","pattern":"^\\+[0-9]+$","minLength":12,"maxLength":12},"language":{"type":"string","enum":["nl","en"],"default":"en"},"dateFormat":{"type":"string","pattern":"^([a-z]{2}_[A-Z]{2})|(iso)$","minLength":3,"maxLength":5,"default":"en_GB"},"groups":{"type":"array","default":[],"items":{"type":"number","maximum":99999}},"sendActivationMail":{"type":"boolean","default":true}}}}}},"responses":{"200":{"description":""}}}}}}
```

## settings

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/settings":{"get":{"tags":["User"],"summary":"settings","description":"**Returns all the settings for this user.**","operationId":"settingsGET","parameters":[{"name":"userID","in":"query","schema":{"type":"number","default":"UID"}}],"responses":{"200":{"description":""}}}}}}
```

## 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.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"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.","operationId":"userItemPUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"firstname":{"type":"string","pattern":"^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$","minLength":1},"lastname":{"type":"string","pattern":"^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$","minLength":1},"name":{"description":"The username of this user.","type":"string","pattern":"^[a-zA-Z0-9\\.\\-]+$","minLength":2},"email":{"type":"string","format":"email","minLength":1},"telephone":{"type":"string","pattern":"^\\+[0-9]+$","minLength":12,"maxLength":12},"language":{"type":"string","enum":["nl","en"]},"dateFormat":{"type":"string","pattern":"^([a-z]{2}_[A-Z]{2})|(iso)$","minLength":3,"maxLength":5},"groups":{"type":"array","items":{"type":"number"}}}}}}},"responses":{"200":{"description":""}}}}}}
```

## item

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/{id}":{"delete":{"tags":["User"],"summary":"item","description":"**Deletes this user by their ID.**","operationId":"userItemDELETE","responses":{"200":{"description":""}}}}}}
```

## activate

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/activate":{"put":{"tags":["User"],"summary":"activate","description":"**Activates this user in the database.**","operationId":"activatePUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"number"}}}}}},"responses":{"200":{"description":""}}}}}}
```

## deactivate

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/deactivate":{"put":{"tags":["User"],"summary":"deactivate","description":"**Deactivates this user in the database.**","operationId":"deactivatePUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"number"}}}}}},"responses":{"200":{"description":""}}}}}}
```

## getUserViews

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}},"parameters":{"itemStart":{"name":"itemStart","in":"query","schema":{"type":"number","default":0}}}},"paths":{"/api/v2/user/getUserViews":{"get":{"tags":["User"],"summary":"getUserViews","description":"**Returns the selected views of this user.**","operationId":"getUserViewsGET","parameters":[{"name":"userID","in":"query","schema":{"type":"number","default":"UID"}},{"name":"query","in":"query","schema":{"type":"string","pattern":"^[0-9a-zA-Z \\-\\_]+$","minLength":1,"default":""}},{"$ref":"#/components/parameters/itemStart"},{"name":"itemLimit","in":"query","schema":{"type":"number","maximum":9999,"default":15}}],"responses":{"200":{"description":""}}}}}}
```

## updateUserView

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/updateUserView":{"put":{"tags":["User"],"summary":"updateUserView","description":"**Updates the selected views for this user.**","operationId":"updateUserViewPUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["viewID","newValue"],"properties":{"userID":{"type":"number","default":"UID"},"viewID":{"type":"number"},"newValue":{"type":"number","maximum":1}}}}}},"responses":{"200":{"description":""}}}}}}
```

## maxChats

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/maxChats":{"put":{"tags":["User"],"summary":"maxChats","description":"**Updates the maximum chats for this user.**","operationId":"maxChatsPUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["maxChats"],"properties":{"userID":{"type":"number","default":"UID"},"maxChats":{"type":"number"}}}}}},"responses":{"200":{"description":""}}}}}}
```

## chatSoundNewMessage

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/chatSoundNewMessage":{"put":{"tags":["User"],"summary":"chatSoundNewMessage","description":"**Updates the chat sound on or off for this user.**","operationId":"chatSoundNewMessagePUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["state"],"properties":{"userID":{"type":"number","default":"UID"},"state":{"type":"number","maximum":1}}}}}},"responses":{"200":{"description":""}}}}}}
```

## notifyOnTicketAssignment

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"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.**","operationId":"notifyOnTicketAssignmentPUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["state"],"properties":{"userID":{"type":"number","default":"UID"},"state":{"type":"number","maximum":1}}}}}},"responses":{"200":{"description":""}}}}}}
```

## userStatistic

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/userStatistic":{"get":{"tags":["User"],"summary":"userStatistic","description":"**Returns this user's statistics.**","operationId":"userStatisticGET","parameters":[{"name":"userID","in":"query","schema":{"type":"number","default":"UID"}}],"responses":{"200":{"description":""}}}}}}
```

## userStatistic

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/userStatistic":{"post":{"tags":["User"],"summary":"userStatistic","description":"**Adds user statistic KPI.**","operationId":"userStatisticPOST","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["statistic"],"properties":{"userID":{"type":"number","default":"UID"},"statistic":{"type":"string","pattern":"^[a-zA-Z\\_]+$","minLength":1},"statisticOption":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":1,"default":""},"statisticSecondaryOption":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":1,"default":""}}}}}},"responses":{"200":{"description":""}}}}}}
```

## userStatistic

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/userStatistic":{"delete":{"tags":["User"],"summary":"userStatistic","description":"**Deletes user statistic settings.**","operationId":"userStatisticDELETE","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["statistic"],"properties":{"userID":{"type":"number","default":"UID"},"statistic":{"type":"string","pattern":"^[a-zA-Z\\_]+$","minLength":1},"statisticPrimaryOption":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":1,"default":""},"statisticSecondaryOption":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":1,"default":""}}}}}},"responses":{"200":{"description":""}}}}}}
```

## watch

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/watch":{"put":{"tags":["User"],"summary":"watch","description":"**Updates this user's statistics watch setting.**","operationId":"watchPUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["statistic","watchToggle"],"properties":{"userID":{"type":"number","default":"UID"},"statistic":{"type":"string","pattern":"^[a-zA-Z\\_]+$","minLength":1},"statisticPrimaryOption":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":1,"default":""},"statisticSecondaryOption":{"type":"string","pattern":"^[0-9a-zA-Z]+$","minLength":1,"default":""},"watchToggle":{"type":"string","enum":["watch","unwatch"]}}}}}},"responses":{"200":{"description":""}}}}}}
```

## refreshTab

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/refreshTab":{"post":{"tags":["User"],"summary":"refreshTab","description":"**Invokes a refresh on this tab.**","operationId":"refreshTabPOST","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["tabID"],"properties":{"tabID":{"type":"string","pattern":"^[a-zA-Z0-9\\_]+$","minLength":1}}}}}},"responses":{"200":{"description":""}}}}}}
```

## updateStatus

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/updateStatus":{"post":{"tags":["User"],"summary":"updateStatus","description":"**Updates this user's status.**","operationId":"updateStatusPOST","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["userEmailAddress","statusID"],"properties":{"userID":{"type":"number"},"userEmailAddress":{"type":"string","format":"email","minLength":1},"statusID":{"type":"number"},"lastInternalCallID":{"type":"number"},"browserRequestTime":{"type":"number","default":0}}}}}},"responses":{"200":{"description":""}}}}}}
```

## ticketIncognitoMode

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/ticketIncognitoMode":{"put":{"tags":["User"],"summary":"ticketIncognitoMode","description":"**Updates this user's incognito mode on tickets.**","operationId":"ticketIncognitoModePUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["state"],"properties":{"userID":{"type":"number","default":"UID"},"state":{"type":"number","maximum":1}}}}}},"responses":{"200":{"description":""}}}}}}
```

## callsAutoAnswer

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/callsAutoAnswer":{"put":{"tags":["User"],"summary":"callsAutoAnswer","description":"**Updates this user's setting on automatically answering calls.**","operationId":"callsAutoAnswerPUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["state"],"properties":{"userID":{"type":"number","default":"UID"},"state":{"type":"number","maximum":1}}}}}},"responses":{"200":{"description":""}}}}}}
```

## userCampaignState

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/userCampaignState":{"post":{"tags":["User"],"summary":"userCampaignState","description":"**Sets this user's active or inactive campaigns.**","operationId":"userCampaignStatePOST","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["campaign","state"],"properties":{"userID":{"type":"number","default":"UID"},"campaign":{"description":"Name of the campaign you want to set the user's status to.","type":"string","pattern":"^[a-zA-z0-9\\-_]+$","minLength":1},"state":{"type":"number","maximum":1}}}}}},"responses":{"200":{"description":""}}}}}}
```

## statusLock

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/statusLock":{"post":{"tags":["User"],"summary":"statusLock","description":"**Sets this user to a specific status and locks it.**","operationId":"statusLockPOST","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["userID","status"],"properties":{"userID":{"type":"number"},"status":{"type":"number"}}}}}},"responses":{"200":{"description":""}}}}}}
```

## statusLockDelete

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/statusLockDelete":{"post":{"tags":["User"],"summary":"statusLockDelete","description":"**Deletes the status lock on this user.**","operationId":"statusLockDeletePOST","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["userID"],"properties":{"userID":{"type":"number"}}}}}},"responses":{"200":{"description":""}}}}}}
```

## userDashboard

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/userDashboard":{"get":{"tags":["User"],"summary":"userDashboard","description":"**Returns this user's dashboard data.**\n\nE.g. name, ID and avatar.","operationId":"userDashboardGET","parameters":[{"name":"userID","in":"query","schema":{"type":"number","default":"UID"}}],"responses":{"200":{"description":""}}}}}}
```

## userActivationLink

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/userActivationLink":{"get":{"tags":["User"],"summary":"userActivationLink","description":"**Sends this user an account activation link.**","operationId":"userActivationLinkGET","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":""}}}}}}
```

## usernameUpdate

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/usernameUpdate":{"put":{"tags":["User"],"summary":"usernameUpdate","description":"**Updates this user's username.**","operationId":"usernameUpdatePUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["id","username"],"properties":{"id":{"type":"number"},"username":{"type":"string","pattern":"^[a-zA-Z0-9\\.\\-]+$","minLength":2}}}}}},"responses":{"200":{"description":""}}}}}}
```

## firstnameUpdate

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/firstnameUpdate":{"put":{"tags":["User"],"summary":"firstnameUpdate","description":"**Updates this user's first name.**","operationId":"firstnameUpdatePUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["id","firstname"],"properties":{"id":{"type":"number"},"firstname":{"type":"string","pattern":"^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$","minLength":1}}}}}},"responses":{"200":{"description":""}}}}}}
```

## lastnameUpdate

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

```json
{"openapi":"3.0.3","info":{"title":"Omnidesk API documentation","version":"2.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":"{{base_url}}"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"}}},"paths":{"/api/v2/user/lastnameUpdate":{"put":{"tags":["User"],"summary":"lastnameUpdate","description":"**Updates this user's last name.**","operationId":"lastnameUpdatePUT","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["id","lastname"],"properties":{"id":{"type":"number"},"lastname":{"type":"string","pattern":"^[a-zA-ZÀ-ÖØ-Þß-öø-ÿ\\- ]+$","minLength":1}}}}}},"responses":{"200":{"description":""}}}}}}
```