Update user access permissions

The PATCH /users/{userId}/permissions/accessPermissions endpoint updates the access permissions for the user matching the provided user ID.

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

Parameters

The endpoint accepts the following query parameter:

userID

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.