Docmost Octri Preview
POST/groups/members/add

Add users to a group

Adds users to a workspace group, skipping users who are already members. Supply groupId and between 1 and 50 user IDs in userIds. You need Manage/Group workspace permission to add members.

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

2 body fields

The group and user IDs for the members to add.

groupIdstringrequired
ID of the group to add users to.
userIdsarray<string>required
User IDs to add to the group. 1–50 per request. Users already in the group are skipped.

3 status codes
200Returns a success response confirming that the group members were added.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when required fields are missing or 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 required fields are missing or the request fails validation. A 403 is returned when the authenticated user lacks Manage/Group workspace permission. groupId and each entry in userIds must be UUIDs, and userIds must contain between 1 and 50 entries.