Docmost Octri Preview
POST/groups/create

Create a new group

Creates a group in the workspace and can add initial members. Provide a name between 2 and 100 characters; userIds can contain up to 50 UUIDs. You need Manage/Group workspace permission to create a group.

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

3 body fields

The group name and optional description and initial members.

descriptionstringoptional
Optional group description.
namestringrequired
Display name for the group.
userIdsarray<string>optional
User IDs to add as initial members when creating the group. Max 50.

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

Error handling

A 403 is returned when the authenticated user lacks Manage/Group workspace permission. name is required and must be between 2 and 100 characters; userIds can contain at most 50 UUIDs.