Versions Compared

Key

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

The PUT /groups/{groupId}/users endpoint replaces the users who have the group that matches the group 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:

groupID

Type

Required

Example

StringTrue2f9207ca-8922-4245-bfc5-d8f42939e29a

The group ID of the required group.

Request body parameters

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

Example request body

Code Block
languagejs
themeMidnight
{
  "userId": "85e4de21-30a0-4a37-88e1-1484c6183a50"
}

where:

  • userIDThe unique ID of the user in the group.

Responses

Successful response

Successful requests return a 200 Success code.