diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 936b5b8..4efb46e 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -703,6 +703,7 @@ export default withMermaid( { text: "Overview", link: "/api-reference/members/overview" }, { text: "Get Workspace Members", link: "/api-reference/members/get-workspace-members" }, { text: "Get Project Members", link: "/api-reference/members/get-project-members" }, + { text: "Remove Workspace Members", link: "/api-reference/members/remove-workspace-member" }, ], }, { diff --git a/docs/api-reference/members/remove-workspace-member.md b/docs/api-reference/members/remove-workspace-member.md new file mode 100644 index 0000000..767ad00 --- /dev/null +++ b/docs/api-reference/members/remove-workspace-member.md @@ -0,0 +1,157 @@ +--- +title: Remove workspace member +description: Remove a member from a workspace via Plane API. HTTP POST request to deactivate users across projects and teamspaces. +keywords: plane api, remove member, delete member, workspace members, user management, rest api, api integration +--- + +# Remove workspace member + +
+ POST + /api/v1/workspaces/{slug}/members/remove/ +
+ +
+
+ +Removes a member from a workspace. This deactivates them across all projects, removes them from teamspaces and pages, and optionally reduces seat count. + +
+ +### Path parameters + +
+ + + +The unique identifier (slug) for the workspace. + + + +
+
+ +
+ +### Body Parameters + +
+ + + +Email address of the member to remove. + + + + + +Reduce purchased seat count by 1. Defaults to `false`. + + + +
+
+ +
+ +### Scopes + +`write` or `workspaces:members:write` + +
+ +
+ +### Responses + +| Status | Description | +| ------ | -------------------------------------- | +| 204 | Member removed successfully (no body) | +| 400 | Validation error (see below) | +| 403 | You are not a member of this workspace | +| 404 | Workspace or member not found | + +**400 Validation Errors:** + +- `email` field is required. +- Cannot remove yourself. You'll need leave the workspace from the application. +- Cannot remove a member with a higher role than yours. +- Member is the sole admin of one or more projects — promote another admin first. + +
+ +
+ +### What happens + +- Member is deactivated in all projects. +- Member is removed from all teamspaces and shared pages +- If `remove_seat` is `true` and unused seats exist, one seat is removed from your plan. +
+ +
+
+ + + + + + + + + +```json +No Content +``` + + + +
+