Transfer workspace ownership

​

Overview

• The new owner must be a verified user in the tenant — they need not already be a member.
• The new owner’s existing member row (if any) is removed, keeping ownerId and member rows disjoint.
• The previous owner is demoted into a fresh member row or removed. It defaults to remove whenever the field is omitted — on a voluntary self-transfer as much as on an ancestor-owner reassign; pass "demote" to keep them on the roster. On demote, rank defaults to one rung below you — 0 when you are apex (the usual case), or one below your own row if you are an ancestor owner who also sits in this workspace’s ladder.

​

Usage Example

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

function TransferOwnership({ workspaceId }: { workspaceId: string }) {
  const transferWorkspaceOwnership = useTransferWorkspaceOwnership();

  const handleTransfer = async (newOwnerId: string) => {
    const workspace = await transferWorkspaceOwnership({
      workspaceId,
      newOwnerId,
      previousOwnerDisposition: "demote",
      previousOwnerRank: 0,
      previousOwnerCapabilities: ["view"],
    });
    console.log("New owner:", workspace.ownerId);
  };
}

​

Parameters

​

Returns

​

Error codes

​

Related

• Transfer Ownership API