v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB
Groups (Preferred)

Update a group

Updates the name and/or description of an existing group.

At least one field must be provided. Only the fields included in the request body are updated (partial update semantics).

Requires the GROUPMANAGEMENT security role.

patch/api/1/groups/{groupId}

Path parameters

groupIdstring uuid required

ID of the group to update (hyphens optional).

Request body

namestring

New name for the group. Must be unique within the account.

descriptionstring nullable

New description for the group. Pass null to clear it.

Response

Group updated successfully.

idstring uuid
titlestring
descriptionstring
guideIdsstring[]
visibility'PRIVATE' | 'SPECIFIC' | 'PORTAL' | 'PUBLIC'
ownerIdstring
versioninteger
creationTimestring
lastModifiedTimestring
canEditboolean
canViewboolean
sharedboolean