Update space

Update a space’s settings, name, description, or images

Overview

useUpdateSpace returns a callable function for updating a space. Only space admins can update a space. Supports updating avatar and banner images.

When using SpaceProvider, prefer calling updateSpace from useSpace — it handles state updates automatically.

Usage Example

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

function SpaceSettings({ spaceId }: { spaceId: string }) {
  const updateSpace = useUpdateSpace();

  const handleSave = async (name: string, description: string) => {
    const updated = await updateSpace({
      spaceId,
      update: { name, description },
    });
    console.log("Updated:", updated.name);
  };
}

Parameters

spaceId · string · required

UUID of the space to update.

update · object · required

Fields to update. All fields are optional.

Show update fields

name · string

New display name (3–100 characters).

slug · string | null

New URL slug. Pass null to remove.

description · string | null

New description. Pass null to remove.

readingPermission · "anyone" | "members"

Updated reading permission.

postingPermission · "anyone" | "members" | "admins"

Updated posting permission.

requireJoinApproval · boolean

Updated join approval requirement.

metadata · Record<string, any>

Updated metadata.

avatar · { file: File | Blob; options: UploadImageOptions }

New avatar image to upload.

banner · { file: File | Blob; options: UploadImageOptions }

New banner image to upload.

Returns

Returns the updated SpaceDetailed object.