Skip to main content
PATCH
Update Space
Updates a space. Only the space’s admin can update it. Supports multipart form data for avatar/banner image uploads.

Path Parameters

spaceId
string
required
UUID of the space to update.

Body Parameters

All fields are optional. Only provided fields are updated.
name
string
Updated display name. 3–100 characters.
slug
string
Updated URL slug. Pass empty to clear.
description
string
Updated description.
readingPermission
string
"anyone" or "members".
postingPermission
string
"anyone", "members", or "admins".
visibility
string
"public", "unlisted", or "private". Controls listing/discoverability, independent of readingPermission. Changes take effect immediately and are freely reversible. See Space visibility.
metadata
object
Updated metadata object.
avatarFile
file
New avatar image. Requires avatarFile.options when provided.
bannerFile
file
New banner image. Requires bannerFile.options when provided.

Response

Returns the updated SpaceDetailed object.

Error Responses

Caller is not an admin of the space.
See also: useUpdateSpace