POST /wiki/rest/api/settings/lookandfeel/custom
Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created.
Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be overridden.
Permissions required: 'Admin' permission for the space.
Servers
- https://your-domain.atlassian.net
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
spaceKey |
String | No |
The key of the space for which the look and feel settings will be updated. If this is not set, the global look and feel settings will be updated. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
horizontalHeader |
Object | No | |
horizontalHeader.button |
Object | No | |
horizontalHeader.button.backgroundColor |
String | Yes | |
horizontalHeader.button.color |
String | Yes | |
horizontalHeader.search |
Object | No | |
horizontalHeader.search.backgroundColor |
String | Yes | |
horizontalHeader.search.color |
String | Yes | |
horizontalHeader.secondaryNavigation |
Object | No | |
horizontalHeader.secondaryNavigation.hoverOrFocus |
Object | Yes | |
horizontalHeader.secondaryNavigation.hoverOrFocus.backgroundColor |
String | Yes | |
horizontalHeader.secondaryNavigation.hoverOrFocus.color |
String | Yes | |
horizontalHeader.secondaryNavigation.highlightColor |
String | No | |
horizontalHeader.secondaryNavigation.color |
String | Yes | |
horizontalHeader.backgroundColor |
String | Yes | |
horizontalHeader.primaryNavigation |
Object | Yes | |
horizontalHeader.primaryNavigation.hoverOrFocus |
Object | No | |
horizontalHeader.primaryNavigation.hoverOrFocus.backgroundColor |
String | No | |
horizontalHeader.primaryNavigation.hoverOrFocus.color |
String | No | |
horizontalHeader.primaryNavigation.highlightColor |
String | Yes | |
horizontalHeader.primaryNavigation.color |
String | No | |
bordersAndDividers |
Object | Yes | |
bordersAndDividers.color |
String | Yes | |
menus |
Object | Yes | |
menus.hoverOrFocus |
Object | Yes | |
menus.hoverOrFocus.backgroundColor |
String | Yes | |
menus.color |
String | Yes | |
header |
Object | Yes | |
header.button |
Object | Yes | |
header.button.backgroundColor |
String | Yes | |
header.button.color |
String | Yes | |
header.search |
Object | Yes | |
header.search.backgroundColor |
String | Yes | |
header.search.color |
String | Yes | |
header.secondaryNavigation |
Object | Yes | |
header.secondaryNavigation.hoverOrFocus |
Object | Yes | |
header.secondaryNavigation.hoverOrFocus.backgroundColor |
String | Yes | |
header.secondaryNavigation.hoverOrFocus.color |
String | Yes | |
header.secondaryNavigation.highlightColor |
String | No | |
header.secondaryNavigation.color |
String | Yes | |
header.backgroundColor |
String | Yes | |
header.primaryNavigation |
Object | Yes | |
header.primaryNavigation.hoverOrFocus |
Object | Yes | |
header.primaryNavigation.hoverOrFocus.backgroundColor |
String | Yes | |
header.primaryNavigation.hoverOrFocus.color |
String | Yes | |
header.primaryNavigation.highlightColor |
String | No | |
header.primaryNavigation.color |
String | Yes | |
spaceReference |
Object | No | |
content |
Object | Yes | |
content.screen |
Object | No | |
content.screen.backgroundOrigin |
String | No | |
content.screen.backgroundPosition |
String | No | |
content.screen.gutterBottom |
String | No | |
content.screen.gutterLeft |
String | No | |
content.screen.backgroundBlendMode |
String | No | |
content.screen.gutterRight |
String | No | |
content.screen.backgroundImage |
String | No | |
content.screen.backgroundRepeat |
String | No | |
content.screen.backgroundSize |
String | No | |
content.screen.gutterTop |
String | No | |
content.screen.backgroundAttachment |
String | No | |
content.screen.layer |
Object | No | |
content.screen.layer.height |
String | No | |
content.screen.layer.width |
String | No | |
content.screen.background |
String | Yes | |
content.screen.backgroundClip |
String | No | |
content.screen.backgroundColor |
String | No | |
content.header |
Object | No | |
content.header.backgroundOrigin |
String | No | |
content.header.backgroundPosition |
String | No | |
content.header.backgroundSize |
String | Yes | |
content.header.backgroundAttachment |
String | No | |
content.header.backgroundBlendMode |
String | No | |
content.header.padding |
String | Yes | |
content.header.backgroundImage |
String | Yes | |
content.header.borderRadius |
String | Yes | |
content.header.backgroundRepeat |
String | No | |
content.header.background |
String | Yes | |
content.header.backgroundClip |
String | No | |
content.header.backgroundColor |
String | Yes | |
content.container |
Object | No | |
content.container.backgroundOrigin |
String | No | |
content.container.backgroundPosition |
String | No | |
content.container.backgroundSize |
String | Yes | |
content.container.backgroundAttachment |
String | No | |
content.container.backgroundBlendMode |
String | No | |
content.container.padding |
String | Yes | |
content.container.backgroundImage |
String | Yes | |
content.container.borderRadius |
String | Yes | |
content.container.backgroundRepeat |
String | No | |
content.container.background |
String | Yes | |
content.container.backgroundClip |
String | No | |
content.container.backgroundColor |
String | Yes | |
content.body |
Object | No | |
content.body.backgroundOrigin |
String | No | |
content.body.backgroundPosition |
String | No | |
content.body.backgroundSize |
String | Yes | |
content.body.backgroundAttachment |
String | No | |
content.body.backgroundBlendMode |
String | No | |
content.body.padding |
String | Yes | |
content.body.backgroundImage |
String | Yes | |
content.body.borderRadius |
String | Yes | |
content.body.backgroundRepeat |
String | No | |
content.body.background |
String | Yes | |
content.body.backgroundClip |
String | No | |
content.body.backgroundColor |
String | Yes | |
links |
Object | Yes | |
links.color |
String | Yes | |
headings |
Object | Yes | |
headings.color |
String | Yes |
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.