The PATCH /groups/{groupId}
endpoint updates the group matching the provided group ID with provided values.
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
Scope | Access granted |
---|---|
users:write | Entire endpoint |
groupId
Type | Required | Example |
---|---|---|
String | True | 8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
The group ID of the required group.
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>" |
The endpoint requires a group object in JSON format as in the 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.Successful requests return a 200 Success
code.