The PUT /users/{userId}/groups endpoint replaces the user’s groups for the user matching the user ID provided.
In this page
Request parameters
Query parameters
The endpoint accepts the following query parameters:
userID
Type | Required | Example |
|---|---|---|
| String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
Request body parameters
The endpoint requires an agentGroups object in JSON format as in the request body.
Example request body
{
"agentGroups": [
{
"groupId": "bfe83c27-1daa-4f4f-9f80-e278bf79e327"
}
]
}
where:
agentGroups. The groups that the agent is in.groupId. The unique ID of the group.
Responses
Successful response
Successful requests return a 200 Success code.