Docmost Octri Preview
POST/workspace/update

Update workspace settings

Updates settings for the workspace. Supply the settings you want to change, such as name, hostname, or feature flags; changing hostname logs users out from the old hostname. The authenticated user needs Manage/Settings permission.

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

17 body fields

Workspace settings to update.

aiChatbooleanoptional
Enable the conversational AI assistant.
aiSearchbooleanoptional
Enable AI-powered semantic search.
allowMemberTemplatesbooleanoptional
Allow space members with edit access, not just admins, to create templates.
allowPersonalSpacesbooleanoptional
Allow users to create personal spaces.
defaultPageEditModestringoptional
Mode a page opens in by default.
Allowed:readedit
descriptionstringoptional
Workspace description.
disablePublicSharingbooleanoptional
If `true`, disables public page sharing across the entire workspace. Overrides space-level sharing settings.
emailDomainsarray<string>optional
Allowed email domains for signup (e.g. `["example.com"]`). Used with SSO enforcement to restrict which email domains can join.
enforceMfabooleanoptional
If `true`, all users are required to set up multi-factor authentication. Users without MFA are prompted to configure it on login.
enforceSsobooleanoptional
If `true`, traditional email/password login is disabled. All users must authenticate via a configured SSO provider.
generativeAibooleanoptional
Enable generative AI features such as content generation.
hostnamestringoptional
Subdomain identifier. Alphanumeric, lowercased. Changing this logs users out from the old hostname.
isScimEnabledbooleanoptional
Enable SCIM user and group provisioning.
mcpEnabledbooleanoptional
Enable the MCP endpoint for this workspace.
namestringoptional
Workspace display name.
restrictApiToAdminsbooleanoptional
If `true`, only workspace admins can create and manage API keys. Regular members cannot create API keys.
trashRetentionDaysintegeroptional
Days a deleted page stays in trash before permanent removal.

3 status codes
200Returns the updated workspace settings.
dataobjectoptional
Workspace with a computed member count.
statusintegeroptional
successbooleanoptional
400Returned when a supplied setting fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the authenticated user does not have permission to manage workspace settings.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when a supplied setting fails validation; hostname must be 4–30 characters and name must be 1–64 characters. A 403 is returned when the authenticated user lacks Manage/Settings permission.