platform

Update Group

Patch a group's display name, description, and optionally organization.

A field absent from the request body leaves the column untouched; a field set to null clears display_name / description. Reassigning organization_id additionally requires group owner plus editor on the destination organization.

patch/api/platform/groups/{group_id}

Path parameters

group_idstring required

Request body

displayNamestring nullable

New display name; null clears it.

descriptionstring nullable

New description; null clears it.

organizationIdstring nullable

Move group to this organization.

Response

Successful Response

idstring required

organizationIdstring required

organizationNamestring nullable

displayNamestring nullable

descriptionstring nullable

memberCountinteger

isAllMembersboolean

fgaSyncStatusstring

fgaLastErrorstring nullable

fgaLastReconciledAtstring date-time nullable

createdAtstring date-time nullable

updatedAtstring date-time nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.