Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The PUT /users/{userId}/permissions/queues endpoint replaces the user’s queue permissions for the user matching the user ID provided.

Panel
borderColor#eeeeee
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#7ec9f4
borderStylesolid
titleIn this page

Table of Contents

Request parameters

Query parameters

The endpoint accepts the following query parameters:

userID

Type

Required

Example

StringTrue2f9207ca-8922-4245-bfc5-d8f42939e29a

The user ID of the required user.

Request body parameters

The endpoint requires a queues object in JSON format as in the request body.

Example request body

Code Block
languagejs
themeMidnight
{
  "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.