Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB
User

Update a user group

Update an existing user group.

patch/users/groups/{group_id}

Path parameters

group_idinteger required

ID of the user group to update.

ID of the user group to update.

Query parameters

cookie_namestring nullable
tenant_idinteger

Request body

namestring required

Display name of the user group.

descriptionstring nullable

Optional description of the group's purpose.

Example request

{
  "name": "Engineering",
  "description": "All engineering staff."
}

Response

Successful Response

created_atstring date-time

UTC timestamp when the record was created.

updated_atstring date-time

UTC timestamp when the record was last updated.

idinteger nullable

Primary key for UserGroups.

tenant_idinteger required

ID of the tenant.

namestring

Name of the user group.

descriptionstring nullable

Description of the user group.

creator_user_idinteger nullable required

ID of the user who created the group.

Example response

{
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-16T08:00:00Z"
}