The PUT /groups/{groupId}/users endpoint replaces the users who have the group that matches the group ID provided.
...
Insert excerpt _ExcerptAPICloudNextGen _ExcerptAPICloudNextGen nopanel true
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
users:write | Entire endpoint |
Parameters
groupID
Type | Required | Example |
|---|---|---|
| String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The group ID of the required group.
...
The endpoint requires a users object in JSON format as in the request body.
Example request body
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"users": [
{
"userId": "85e4de21-30a0-4a37-88e1-1484c6183a50"
}
]
} |
where:
userID. The unique ID of the user in the group.
Responses
Successful response
Successful requests return a 200 Success code.