The PUT
/users/{userId}/permissions/queues
endpoint replaces the user’s queue permissions for the user matching the user ID provided.
In this page
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
Scope | Access granted |
---|---|
users:write | Entire endpoint |
Parameters
userID
Type | Required | Example |
---|---|---|
String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
Requests
Example Request
curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/queues" \ -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 a queues
object in JSON format as in the request body.
Example request body
{ "queues": [ { "queueId": "1d75b21f-6d94-4477-9ba7-513a30bfc21d", "queuePermission": "Read" }, { "queueId": "fd6e3099-8673-4b11-865b-2e15ec80911a", "queuePermission": "Write" } ] }
where:
queues
. The user’s queue permissions.queueId
. The user’s queue permissions that the user has access to.queuePermission
. Access levels for accessing resources such as Queues. Possible values: None, Read, Write.
Responses
Successful response
Successful requests return a 200 Success
code.
Try it out
For information, see Trying out Vonage Contact Center APIs.