ATatlassian
Space

Update space

Updates the name, description, or homepage of a space.

  • For security reasons, permissions cannot be updated via the API and must be changed via the user interface instead.
  • Currently you cannot set space labels when updating a space.

Permissions required: 'Admin' permission for the space.

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

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}
  • 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 to update.

Request body

namestring nullable

The updated name of the space.

homepageobject nullable

The updated homepage for this space

typestring

The updated type for this space.

statusstring nullable

The updated status for this space.

Response

Returned if the space is updated.

idinteger
keystring required
aliasstring
namestring required
typestring required
statusstring required
_linksGenericLinks required

Changes

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