Docmost Octri Preview
POST/spaces/update

Update space settings

Updates settings for a space. Supply spaceId and any settings you want to change; name and slug must be 2–100 characters, and the slug must be unique within the workspace. Disabling public sharing deletes existing shares for pages in the space.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Space settings to update. spaceId is required; all other fields are optional.

allowViewerCommentsbooleanoptional
If `true`, members with reader access may comment.
descriptionstringoptional
New description.
disablePublicSharingbooleanoptional
If `true`, prevents creation of public shares for pages in this space. Existing shares are deleted.
namestringoptional
New display name.
slugstringoptional
New URL slug. Must be unique within the workspace.
spaceIdstringrequired
ID of the space to update.

3 status codes
200Returns the updated space.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when the request fails validation, including when the `name` or `slug` is outside the allowed length or the `slug` is not unique within the workspace.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the authenticated user lacks permission to update the space settings.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when name or slug is shorter than 2 characters or longer than 100, or when the slug is not unique within the workspace. A 403 is returned when the authenticated user lacks Manage/Settings permission for the space.