...
| Code Block | ||
|---|---|---|
| ||
{
"name": "Custom Theme",
"organization": {
"id": "100465"
},
"appHeaderFooterColor": "#353535",
"adminHeaderColor": "#2587e8",
"buttonColor": "#2587e8",
"buttonHoverColor": "#8cbff3",
"borderEnabled": false,
"borderColor": "#353535",
"sidebarColor": "#353535",
"sidebarIconColor": "#2587e8",
"additionalCss": ".logo-main { display: none; }"
} |
Field Descriptions
See The User Guide includes screenshots showing what each property customizes (see https://sharptop.atlassian.net/wiki/spaces/CCD/pages/2652274691/Custom+Themes#Feature-Explanations for an explanation of how each field configures the application .
A valid CSS color should match the following regular expression: /^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$|^rgb\(\s*(\d+%?\s*,\s*){2}(\d+%?)\s*\)$|^rgba\(\s*(\d+%?\s*,\s*){3}(1|0?\.\d+)\s*\)$|^hsl\(\s*(\d+%?\s*,\s*){2}(\d+%?)\s*\)$|^hsla\(\s*(\d+%?\s*,\s*){3}(1|0?\.\d+)\s*\)$/
Field | Description |
|---|---|
name (required) | Name of custom theme. Currently only one custom theme is supported per organization. |
organization.id (required) | ID of organization to which the theme belongs |
appHeaderFooterColor (required) | Valid CSS Color |
adminHeaderColor (required) | Valid CSS Color |
buttonColor (required) | Valid CSS Color |
buttonHoverColor (required) | Valid CSS Color |
borderColor (required) | Valid CSS Color |
sidebarColor (required) | Valid CSS Color |
sidebarIconColor (required) | Valid CSS Color |
encodedLogo (optional) | Valid Base64 encoded png image. If provided, the resulting png file will be uploaded to our S3 and the url to the S3 file added as logoAssetUrl |
logoAssetUrl (optional) | Valid URL to an image that is accessible within the content security policy. Omit if specifying encodedLogo. |
additionalCss (optional) | Max Length 4096 characters. Block of additional CSS. This will be inserted at the bottom of the CSS file for this theme. |
Example Response
| Code Block |
|---|
{
"id": 46,
"buttonHoverColor": "#8cbff3",
"buttonColor": "#2587e8",
"additionalCss": ".logo-main { display: none; null}",
"organization": {
"id": 100465
},
"borderColor": "#353535",
"adminHeaderColor": "#2587e8",
"logoAssetUrl": null,
"sidebarIconColor": "#2587e8",
"appHeaderFooterColor": "#353535",
"borderEnabled": false,
"name": "Custom Theme",
"sidebarColor": "#353535"
} |
...