The PUT /users/{userId}/groups endpoint replaces the user’s groups for the user matching the user ID provided.
...
Authorization scopes supported:
| Scope | Access granted |
|---|---|
users:write | Entire endpoint |
Parameters
userID
Type | Required | Example |
|---|---|---|
| String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
Requests
Example Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/groups" \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
--data-raw "<JSON BODY>" |
...
| Tip |
|---|
This endpoint replaces the agents groups.
|
Example request body
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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.
Insert excerpt _ExcerptRunInPostman _ExcerptRunInPostman nopanel true