Sign in

v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
beta.admin.user-groups

Update User Group

Update a user group.

patch/v1/admin/user-groups/{group_uuid}

Path parameters

group_uuidstring uuid required

Request body

namestring nullable

Updated name of the user group.

descriptionstring nullable

Updated description of the user group.

target_type'W' | 'O'

Example request

{
  "name": "Engineering Team",
  "description": "Members of the platform engineering team"
}

Response

OK

uuidstring uuid required

User group ID.

namestring required

Name of the user group.

descriptionstring nullable required

Optional description of the user group.

externally_managedboolean nullable

Whether the group is managed by an external system.

target_type'W' | 'O'
organization_rolestring nullable

Organization role assigned to the group.

Example response

{
  "name": "Engineering Team",
  "description": "Members of the platform engineering team"
}