Update user access permissions
The UPDATE /users/{userId}/permissions/accessPermissions endpoint updates the access permissions for the user matching the provided user ID.
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.newvoicemedia.com USA nam https://nam.api.newvoicemedia.com APAC apac https://apac.api.newvoicemedia.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
users:write | Entire endpoint |
Parameters
The endpoint accepts the following query parameter:
userID
Type | Required | Example |
|---|---|---|
| String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
Requests
Example request
curl -L -X PATCH "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/accessPermissions" \ -H "Content-Type: application/json" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ --data-raw "<JSON BODY>"
Request body parameters
The endpoint requires an accessPermissions object in JSON format as in the request body.
{
"accessPermissions": [
{
"permissionKey": "CPA_View",
"permissionLevel": "Read"
},
{
"permissionKey": "AccessUserAdmin",
"permissionLevel": "Yes"
}
]
}
where:
accessPermissions. The user’s queue permissions.permissionKey. The user’s access permission key.permissionLevel. Access levels for Access Permission. Possible values: Yes, No, Read, Modify, None.
Responses
Successful response
Successful requests return a 200 Success code.
For information, see Trying out Vonage Contact Center APIs.