Update group by group ID

Owned by Helen Griffith
Last updated: Sept 26, 2024

The PATCH /groups/{groupId} endpoint updates the group matching the provided group ID with provided values.

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

StringTrue8e22b1fe-d2ea-403d-8c03-50eb21188e79

The group ID of the required group.

Requests

Example Request

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

Example request body

{
  "groupName": "changed name",
  "groupMaxUnexpectedTime": 7200,
  "groupMaxWrapUpTime": 7200
}

where:

  • groupName. The name of the group.
  • groupMaxUnexpectedTime. The maximum time, in seconds, that a user in the group can be in any of the Unexpected or Fault states, such as Fault on Line, No Answer, or Line Busy. The default is 10 seconds.
  • groupMaxWrapUpTime. The maximum time, in seconds, that a user in the group can be in the Wrap Up (Auto) state. The default is 10 seconds.

Response

Successful response

Successful requests return a 200 Success code.


Try it out

  

For information, see Trying out Vonage Contact Center APIs.