Versions Compared

Key

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

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

...

Type

Required

Example

StringTrue2f9207ca-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

Code Block
languagejs
themeMidnight
{
  "agentGroups": [
    {
      "groupId": "bfe83c27-1daa-4f4f-9f80-e278bf79e327"
    }
  ]
}

where:

  • agentGroupsThe groups that the agent is in.
    • groupIdThe unique ID of the group.

Responses

Successful response

Successful requests return a 200 Success code.