Update workspace

Overview

useUpdateWorkspace returns a callable that edits a workspace’s own name and/or metadata. The actor is the signed-in user. Authorization: capability-gated. Requires the edit-workspace capability (owners hold it implicitly).

This does not flip inheritsFromParent — that is a separate owner-only action, useUpdateWorkspaceInheritFlag.

Usage Example

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

function RenameWorkspace({ workspaceId }: { workspaceId: string }) {
  const updateWorkspace = useUpdateWorkspace();

  const handleRename = async (name: string) => {
    const workspace = await updateWorkspace({ workspaceId, name });
    console.log("Renamed to:", workspace.name);
  };
}

Parameters

string

required

The workspace UUID.

string

New display name. 1–100 characters.

Record<string, any>

New opaque developer metadata.

Returns

Returns the updated Workspace object.

Error codes

Code	Status	Meaning
`workspace/unauthorized`	403	You lack the `edit-workspace` capability.
`workspace/not-found`	404	No such workspace in this project.

useFetchWorkspaceAuthority — check edit-workspace before showing the form
Update Workspace 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