Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Themes

Update a theme

Partially updates a theme. Only provided fields are changed; image fields, when provided, must be base64-encoded data URLs and replace the corresponding stored asset. <br>Required scope: themes:write </br>Organization authorization: supported

put/api/v1/themes/{themeId}

Path parameters

themeIdinteger required

Request body

namestring nullable

Name of the theme

defaultboolean nullable
sidebar_theming_enabledboolean nullable

Whether sidebar theming is enabled

app_primary_colorstring nullable

Primary colour for the app

app_secondary_colorstring nullable

Secondary colour for the app

portal_primary_colorstring nullable

Primary colour for the portal

portal_secondary_colorstring nullable

Secondary colour for the portal

app_imagestring nullable

Replacement app logo as a base64-encoded data URL

portal_imagestring nullable

Replacement portal logo as a base64-encoded data URL

portal_fav_iconstring nullable

Replacement portal favicon as a base64-encoded data URL

Response

Updated theme

idinteger

Unique identifier of the theme

namestring required

Name of the theme

titlestring required

Title of the theme formatted with operator name

primaryColorstring required

Primary color in HEX format

secondaryColorstring required

Secondary color in HEX format

logoUrlstring required

Url of the logo image

favIconUrlstring required

Url of the favicon image

Example response

{
  "id": 1,
  "name": "Custom Theme",
  "title": "Operator Custom Theme",
  "primaryColor": "#FF5733",
  "secondaryColor": "#FF5733",
  "logoUrl": "https://example.com/logo.png",
  "favIconUrl": "https://example.com/favicon.png",
  "operator": {
    "id": 1,
    "identifier": "operator-1",
    "themingEnabled": true
  }
}