Docmost Octri Preview
POST/workspace/members/change-role

Change a member's workspace role

Changes the workspace role assigned to a member identified by userId. Supply the new role as owner, admin, or member; the authenticated user needs Manage/Member permission.

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

2 body fields

Identifies the workspace member and the role to assign.

rolestringrequired
New workspace role. `owner`: full control. `admin`: manage workspace settings and members. `member`: basic access.
Allowed:owneradminmember
userIdstringrequired
ID of the user whose role is being changed.

3 status codes
200Returns confirmation that the member's workspace role was updated.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when a required field is missing or fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the authenticated user does not have permission to manage workspace members.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when userId or role is missing, userId is not a valid UUID, or role is not owner, admin, or member. A 403 is returned when the authenticated user lacks Manage/Member permission.