Docmost Octri Preview
POST/groups/delete

Delete a group

Deletes a group from the workspace. Supply the group's UUID in groupId; the default group cannot be deleted, and the authenticated user needs Manage/Group workspace permission. A successful response confirms that the group was deleted.

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

1 body field

The group to delete.

groupIdstringrequired
ID of the group.

3 status codes
200Returns a success response with a data payload confirming the group was deleted.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when you try to delete the default group.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the authenticated user does not have permission to delete the group.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when you try to delete the default group. A 403 is returned when the authenticated user lacks Manage/Group workspace permission; groupId must be a UUID identifying the group.