ATatlassian
Space settings

Update space settings

Updates the settings for a space.

Permissions required: manage/space permission for the space.

Note: To find the display name for each permission ID, call the Get available space permissions API.

put/wiki/rest/api/space/{spaceKey}/settings

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/settings
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:confluence-space

Path parameters

spaceKeystring required

The key of the space whose settings will be updated.

Request body

routeOverrideEnabledboolean

Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

contentMode'standard' | 'compact' nullable

The content rendering mode for the space. Controls spacing and typography in the editor and renderer. Valid values are "standard" and "compact". When set to "compact", content is rendered more densely with smaller spacing and typography.

Response

Returned if space settings are updated.

routeOverrideEnabledboolean required

Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

contentMode'standard' | 'compact' nullable

The content rendering mode for the space. Controls spacing and typography in the editor and renderer. Valid values are "standard" and "compact". When set to "compact", content is rendered more densely with smaller spacing and typography.

spaceKeystring
_linksGenericLinks required

Changes

No recorded changes to this operation across all 2 revisions of this API.