Update group by group ID
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:
- ***. 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
groupId
Type | Required | Example |
---|---|---|
String | True | 8e22b1fe-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.