v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Themes

Create a theme

Creates a new theme for the operator. Image fields accept base64-encoded data URLs (data:image/png;base64,...); supported MIME types are image/png, image/jpeg, image/svg+xml; maximum 4 MB per image. <br>Required scope: themes:write </br>Organization authorization: supported

post/api/v1/themes

Request body

namestring required

Name of the theme

defaultboolean

sidebar_theming_enabledboolean

Whether sidebar theming is enabled

app_primary_colorstring required

Primary colour for the app

app_secondary_colorstring required

Secondary colour for the app

portal_primary_colorstring required

Primary colour for the portal

portal_secondary_colorstring required

Secondary colour for the portal

app_imagestring required

App logo as a base64-encoded data URL. Allowed MIME types: image/png, image/jpeg, image/svg+xml. Max 4 MB.

portal_imagestring required

Portal logo as a base64-encoded data URL.

portal_fav_iconstring required

Portal favicon as a base64-encoded data URL.

Example request

{
  "name": "Brand A",
  "app_primary_color": "#1A1A1A",
  "app_secondary_color": "#FFFFFF",
  "portal_primary_color": "#1A1A1A",
  "portal_secondary_color": "#FFFFFF",
  "app_image": "data:image/png;base64,iVBORw0KGgo...",
  "portal_image": "data:image/png;base64,iVBORw0KGgo...",
  "portal_fav_icon": "data:image/png;base64,iVBORw0KGgo..."
}

Response

Created 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
  }
}