Layout settings resources
Get layout settings
GET /settings/layout
Response
{
"logo": {
"desktop": "https://customer.starmind.com/assets/img/logo-wl-starmind-320x64.svg",
"mobile": "https://customer.starmind.com/assets/img/logo-wl-starmind-280x48.svg",
"mail": "https://customer.starmind.com/public/sm_logo.png"
},
"offset": {
"from_top": {
"desktop": "1px",
"mobile": "2px"
}
},
"rating": {
"color": {
"normal": "#FFD51E",
"active": "#22B5E9"
}
},
"cockpit": {
"tag1_color": "#FF7E7E",
"tag2_color": "#FFD51E",
"tag3_color": "#6ED1EE"
},
"notification_badge": {
"background_color": "#EB5A5A"
},
"material_theme": {
"default": {
"primary": "#0091EA",
"accent": "#212121"
},
"header": {
"primary": "#212121",
"accent": "#212121"
}
}
}
Update layout settings
PUT /settings/layout
Update the layouts settings will regenerate all CSS file.
Note:
If a setting key is omitted the setting is ignored. If the value for a setting is set to null
the respective setting is reset to its default value.
Parameter | Payload | Description |
---|---|---|
offset |
json |
![]() |
rating |
json |
![]() |
cockpit |
json |
![]() |
notification_badge |
json |
![]() |
starmind_branding_enabled |
boolean |
![]() |
font.font_face |
string |
A custom font face declaration. This can either be used to specify a font family the browser natively supports or to specify a name for custom font files |
material_theme |
json |
Defines a default and a header theme, each containing a primary and accent base color as a HEX value.
A material color palette will be generated from the specified base color.
|
underline_content_links |
boolean |
Option to underline all primary colored links in their default state (instead of hover only) in user-generated content. It is useful to help distinguish links from normal text when a rather dark primary color is chosen. |
Response
{
"starmind_branding_enabled": true,
"font": {
"font_face": "\"HelveticaNeue-Light\", \"Helvetica Neue Light\", \"Helvetica Neue\", Helvetica, Arial, \"Lucida Grande\", sans-serif",
"bold_file": null,
"normal_file": null
},
"logo": {
"desktop": null,
"mobile": null
},
"offset": {
"from_top": {
"desktop": "1px",
"mobile": "2px"
}
},
"rating": {
"color": {
"normal": "#FFD51E",
"active": "#22B5E9"
}
},
"cockpit": {
"tag1_color": "#FF7E7E",
"tag2_color": "#FFD51E",
"tag3_color": "#6ED1EE"
},
"notification_badge": {
"background_color": "#EB5A5A"
},
"material_theme": {
"default": {
"primary": "#0091EA",
"accent": "#212121"
},
"header": {
"primary": "#212121",
"accent": "#212121"
}
},
"underline_content_links": false
}
Set desktop logo
PUT /settings/layout/logo/desktop
Uploads MUST be performed using the multipart/form-data
Content-Type.
The allowed file types are .png
, .jpg
, .jpeg
, .gif
, svg
files.
(Mime-types: image/jpeg
, image/png
, image/gif
, image/svg+xml
)
The image dimensions must be 320x64 px.
Response
{
"url": "https://cdn.starmind.com/1/network/desktop-8694480e-3a8b-45e0-b4ef-35d65e4e2b1e.png"
}
Reset desktop logo
DELETE /settings/layout/logo/desktop
Response
{
"url": "https://customer.starmind.com/assets/img/logo-wl-starmind-320x64.svg"
}
Set mobile logo
PUT /settings/layout/logo/mobile
Uploads MUST be performed using the multipart/form-data
Content-Type.
The allowed file types are .png
, .jpg
, .jpeg
, .gif
, svg
files.
(Mime-types: image/jpeg
, image/png
, image/gif
, image/svg+xml
)
The image dimensions must be 240x48 px.
Response
{
"url": "https://cdn.starmind.com/1/network/mobile-8694480e-3a8b-45e0-b4ef-35d65e4e2b1e.png"
}
Reset mobile logo
DELETE /settings/layout/logo/mobile
Response
{
"url": "https://customer.starmind.com/assets/img/logo-wl-starmind-280x48.svg"
}
Set email logo
PUT /settings/layout/logo/email
Uploads MUST be performed using the multipart/form-data
Content-Type.
The allowed file types are .png
, .jpg
, .jpeg
, .gif
files.
(Mime-types: image/jpeg
, image/png
, image/gif
)
The image dimensions must be 500x100 px.
Response
{
"url": "https://cdn.starmind.com/1/network/email-8694480e-3a8b-45e0-b4ef-35d65e4e2b1e.png"
}
Reset email logo
DELETE /settings/layout/logo/email
Response
{
"url": "https://customer.starmind.com/public/sm_logo.png"
}
Set favicon
PUT /settings/layout/favicon
Uploads MUST be performed using the multipart/form-data
Content-Type.
The allowed file types are .ico
, .png
, .json
and .xml
files.
(Mime-types: image/x-icon
, image/png
, application/json
, application/xml
)
Following favicon file names are supported:
filename | format / size | description |
---|---|---|
apple-touch-icon.png | Recommended is a picture size of 180x180 | Fallback for Apple / android chrome < M39 devices. |
apple-touch-icon-precomposed.png | Recommended is a picture size of 180x180 | Icon doesn't get precomposed by Apple devices. |
apple-touch-icon-$px -$px .png |
apple-touch-icon-180x180.png , where $px can be any integer |
Apple pin to homescreen / Android chrome < M39 devices. |
favicon.ico | Web App Manifest | Most common favicon format supported by almost every desktop browser. |
generic-icon-$px -$px .png |
generic-icon-192x192.png , where $px can be any integer. |
Generic favicon in any size. Reference those from manifest.json or similar. |
mstile-$px -$px .png |
mstile-310x150.png , where $px can be any integer. |
Windows specific favicon in any size. Reference those from browserconfig.xml or similar. |
manifest.json | W3C Web App manifest | Manifest as required by android Chrome > M39. |
browserconfig.xml | MS Browser configuration file | Browserconfig as required for Windows 8/10 tiles. |
Response
{
"url": "https://customer.starmind.com/$filename"
}
Reset favicon
DELETE /settings/layout/favicon/$filename
Note:
The $filename
must match one of the supported favicon file names.
Response
{
"url": "https://customer.starmind.com/$filename"
}