Remove workspace member

Overview

useRemoveWorkspaceMember returns a callable that removes a direct member from this workspace node only. Fires workspace.member.removed. Authorization: capability-gated + rank-bounded. Requires the remove-member capability, and you may act only on members ranked strictly below you.

Owners have no member row, so removal targets member rows only. Sole-owner protection: the owner cannot be removed while sole owner — transfer ownership first.

Usage Example

import { useRemoveWorkspaceMember } from "@sublay/react-js";

function RemoveButton({
  workspaceId,
  targetUserId,
}: {
  workspaceId: string;
  targetUserId: string;
}) {
  const removeWorkspaceMember = useRemoveWorkspaceMember();

  return (
    <button onClick={() => removeWorkspaceMember({ workspaceId, targetUserId })}>
      Remove
    </button>
  );
}

Parameters

string

required

The workspace UUID.

string

required

The target member to remove — a path param, not an acting user.

Returns

Resolves to void (the endpoint returns 204 No Content).

Error codes

Code	Status	Meaning
`workspace/unauthorized`	403	You lack the `remove-member` capability.
`workspace/insufficient-rank`	403	You may only remove members ranked strictly below you.
`workspace/sole-owner`	409	The sole owner must transfer ownership first.

useRemoveWorkspaceMemberFromSubtree — offboard across descendants too
useLeaveWorkspace — the self-service equivalent
Remove Member API

Overview

Auth Hooks

Current User

User Profiles

Entities

Entity Lists

Spaces

Spaces — Rules

Space Lists

Workspaces

Events

Comments

Reactions

Follows

Connections

Blocks

Collections

App Notifications

Push Notifications

Chat — Conversations

Chat — Messages

Chat — Core

Search

Reports

Storage

Crypto

Project

Custom Tables

Overview

Usage Example

Parameters

Returns

Error codes

​Overview

​Usage Example

​Parameters

​Returns

​Error codes

​Related

Overview

Usage Example

Parameters

Returns

Error codes

Related