Replace user's groups
The PUT /users/{userId}/groups endpoint replaces the user’s groups for the user matching the user ID provided.
In this page
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.newvoicemedia.com USA nam https://nam.api.newvoicemedia.com APAC apac https://apac.api.newvoicemedia.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
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
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>"
Request body parameters
The endpoint requires an agentGroups object in JSON format as in the request body.
This endpoint replaces the agents groups.
- To add a new group, you must request the current group list and append the new group Id.
- To remove a new group, you must request the current group list and remove the target group Id from the list.
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.
Try it out
For information, see Trying out Vonage Contact Center APIs.