PUT /wiki/rest/api/space/{spaceKey}
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.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
spaceKey |
String | Yes |
The key of the space to update. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
homepage |
Object | No |
The updated homepage for this space |
name |
String | No |
The updated name of the space. |
description |
Object | No |
The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space. |
description.plain |
Object | Yes | |
description.plain.representation |
String | No |
Set to 'plain'. |
description.plain.value |
String | No |
The space description. |
type |
String | No |
The updated type for this space. |
status |
String | No |
The updated status for this space. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.