Appearance
Save branding configuration
About 285 wordsLess than 1 minute
apiExtension PluginsBranding
2026-09-01
Saves the branding settings together with any new images. The settings you send replace the stored ones, so read the current configuration with Get branding configuration, change it, and send the whole object back.
| Method and path | POST /plugin/datafor-whitelabel/api/save |
| Permission | Administrator user type |
| Content type | multipart/form-data |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
config | form | string | Yes | The full configuration as a JSON string, with the keys returned by Get branding configuration. Set whiteLabelEnabled to true to use it. |
wl_logo.png | form | file | No | New login page logo (PNG). |
wl_main.png | form | file | No | New console logo (PNG). |
wl_main_small.png | form | file | No | New collapsed-sidebar logo (PNG). |
wl_favicon.ico | form | file | No | New browser tab icon (ICO). |
loginBgImage.png | form | file | No | New login page background (PNG). |
wl_<card id>.png | form | file | No | New image for a report card on Home. |
For each uploaded image, set the matching key in config to its URL, for example "wl_logo.png": "/datafor/plugin/datafor/api/core/wl/wl_logo.png". Set it to an empty string to remove the image and use the default.
Example
curl -u admin:password -X POST \
"http://localhost:28080/datafor/plugin/datafor-whitelabel/api/save" \
-F "config=<branding.json" \
-F "wl_logo.png=@logo.png"branding.json is the data object from Get branding configuration with your changes.
{ "success": true }Changes apply to pages loaded after the save; users may need to reload, and browsers can cache the favicon.
Related: Branding