Delete workspace

Overview

useDeleteWorkspace returns a callable that deletes a workspace. Deletion cascades the entire subtree in one transaction, bottom-up: invitations → members → workspaces. Each deleted workspace fires workspace.deleted — and no workspace.member.removed events for the memberships it tears down. Treat workspace.deleted as removing that workspace’s whole roster; see Webhooks & lifecycle.

Authorization: owner-only. The signed-in user must be this workspace’s own owner or an ancestor owner. There is no delete-workspace capability.

Your own data tagged with a workspace id (docs, issues, etc.) is not deleted by Sublay. React to the workspace.deleted webhook to clean up your own workspace-tagged data.

Usage Example

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

function DangerZone({ workspaceId }: { workspaceId: string }) {
  const deleteWorkspace = useDeleteWorkspace();

  const handleDelete = async () => {
    const { message } = await deleteWorkspace({ workspaceId });
    console.log(message);
  };

  return <button onClick={handleDelete}>Delete workspace</button>;
}

Code	Status	Meaning
`workspace/unauthorized`	403	You are not the owner or an ancestor owner.
`workspace/not-found`	404	No such workspace in this project.

Code

Status

Meaning

workspace/unauthorized

403

You are not the owner or an ancestor owner.

workspace/not-found

404

No such workspace in this project.

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