Replace group's users

Owned by Helen Griffith
Last updated: Sept 26, 2024
1 min read

The PUT /groups/{groupId}/users endpoint replaces the users who have the group that matches the group ID provided.

In this page


Most URLs in the example code use the following values:

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

ScopeAccess granted
users:writeEntire endpoint

Parameters

groupID

Type

Required

Example

StringTrue2f9207ca-8922-4245-bfc5-d8f42939e29a

The group ID of the required group.

Requests

Example Request

curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/groups/8e22b1fe-d2ea-403d-8c03-50eb21188e79/users" \
-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 a users object in JSON format as in the request body.

Example request body

{
  "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.


Try it out

  

For information, see Trying out Vonage Contact Center APIs.