The PATCH /users/{userId} endpoint updates the user matching the provided user ID with provided values.
...
Type | Required | Example |
|---|---|---|
| String | True | 8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
The user ID of the user to update.
acceptArchiveInMultipleAccounts
| Type | Required | Example |
|---|---|---|
| boolean | False | true |
This flag must be set to true if user being archived is linked to multiple accounts. Otherwise error message will appear.
allowOverages
| Type | Required | Example |
|---|---|---|
| boolean | False | false |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -L -X PATCH "https://***.api.newvoicemedia.com/useradmin/users/users8e22b1fe8e22b1fe-d2ea-403d-8c03-50eb21188e79" \ -H "Content-Type: application/json" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ --data-raw "<JSON BODY>" |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -L -X PATCH "https://***.api.newvoicemedia.com/useradmin/users/users8e22b1fe8e22b1fe-d2ea-403d-8c03-50eb21188e79?acceptArchiveInMultipleAccounts=true" \ -H "Content-Type: application/json" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ --data-raw "<JSON BODY>" |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -L -X PATCH "https://***.api.newvoicemedia.com/useradmin/users8e22b1feusers/8e22b1fe-d2ea-403d-8c03-50eb21188e79?allowOverages=true" \ -H "Content-Type: application/json" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ --data-raw "<JSON BODY>" |
...
| Code Block | ||
|---|---|---|
| ||
{
"userAccountConfiguration": {
"agentConfiguration": {
"callRatingFrequencyDefault": true
}
}
} |
Responses
The response contains the updated user object.
Successful response
Successful requests return a 200 Success code and the updated user.
Example response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"userId": "06962e51-7201-e170-6b95-137a032c1b1a",
"username": "Supervisor_full_example",
"name": "Supervisor",
"email": "supervisor@vonage.com",
"ssoExternalId": "supervisor_externalId",
"active": true,
"locked": false,
"userAccountConfiguration": {
"role": "Normal",
"actAsAgent": true,
"agentConfiguration": {
"agentDisplayId": "1234",
"webrtc": true,
"agentControlWebrtc": true,
"handleMultipleInteractions": true,
"enforcedDispositionCodes": true,
"transcribeCalls": true,
"screenRecording": false,
"callParking": true,
"salesCadence": false,
"outboundAutoanswer": true,
"inboundAutoanswer": true,
"outboundWrapUp": 200,
"backToReadyAfterNoAnswer": 100,
"backToReadyAfterLineBusy": 1000,
"backToReadyAfterInvalidNumber": 300,
"backToReadyAfterNetworkIssue": 200,
"callRatingFrequency": 50,
"video": true,
"transcribeCallsRealTime": true,
"callRecordingControls": true,
"location": "GB",
"telephonyAddress": {
"telephoneAddress": "800200",
"telephonyExtension": "44",
"outboundTelephonyRegion": "b4c6e398-ac69-4135-b3fd-64d7a6d14272",
"nationalDisplay": true,
"virtualLocation": "PL",
"preventAutoCallbackNumber" : true,
"selectedCallbackNumberId": "4c0b6793-a4c9-4075-839e-08fb99ba7efd"
},
"capacity": {
"isAgentLevel": true,
"live": 50,
"nonLive": 33,
"semiLive": 40
},
"associatedUsers": [
{
"username": "supervisor_vbc",
"applicationType": "VBC"
}
]
}
}
} |
...