Sign in

v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-23231323.7 KB
Groups

Update an existing group

Update an existing group in Cognito user pool

put/groups/{id}

Path parameters

idstring required

the group's ID

Request body

namestring required
precedenceinteger

Example request

{
  "name": "Th&is is a $£test group!~",
  "precedence": 33
}

Response

The group has been successfully updated

idstring

The unique ID of the group

namestring

The human readable name of the group

precedenceinteger

The precedence of the group

Example response

{
  "id": "123-abc-456-def-789-ghi-0",
  "name": "thisisatestgroup",
  "precedence": 33
}