Docmost Octri Preview
POST/workspace/members/deactivate

Deactivate a workspace member

Deactivates a workspace member identified by userId. Supply the user's UUID and ensure the authenticated user has Manage/Member permission to perform this action.

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

1 body field

Identifies the workspace member to deactivate.

userIdstringrequired
ID of the user to deactivate.

3 status codes
200Returns confirmation that the workspace member was deactivated.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when `userId` 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 is missing or is not a valid UUID. A 403 is returned when the authenticated user lacks Manage/Member permission.