Docmost Octri Preview
POST/groups/update

Update a group

Updates a workspace group and can replace its member set. Supply groupId and include any group properties you want to change. You need Manage/Group workspace permission to update a group.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

The group identifier and any group properties to update.

descriptionstringoptional
New group description.
groupIdstringrequired
ID of the group to update.
namestringoptional
New group name.
userIdsarray<string>optional
Replacement set of member user ids.

3 status codes
200Returns the updated group.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when the request fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the authenticated user lacks Manage/Group workspace permission.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when the request fails validation, including when groupId is missing or a field value violates its constraints. A 403 is returned when the authenticated user lacks Manage/Group workspace permission. groupId must be a UUID; name must be between 2 and 100 characters, and userIds can contain at most 50 UUIDs.