BrandingSet | Metadata API Developer Guide

This type extends the Metadata metadata type and inherits its fullName field.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

BrandingSet components have the suffix brandingSet and are stored in the brandingSets folder.

Version

BrandingSet components are available in API version 40.0 and later.

Special Access Rules

The BrandingSet type is available when at least one of the following is enabled in your org: Digital Experiences, Surveys, or Lightning Experience. All users, including unauthenticated guest users, can access this type.

Fields

Field Name	Field Type	Description
brandingSetProperty	BrandingSetProperty[]	An array containing the name and value of each branding property, such as `TextColor:#333`.
description	string	A description of the set of branding properties.
masterLabel	string	Required. The user interface name of the set of branding properties.
type	string	The assigned branding set definition for this BrandingSet.

BrandingSetProperty

Represents the definition of a branding property in the Theme panel in Experience Builder or in the Edit Theme page in Setup.

Field Name	Field Type	Description
propertyName	string	Required. The name of the branding property, such as `TextColor`.
propertyValue	string	The value of the branding property, such as `#333`.

Branding Properties for Lightning Experience Themes

Use these properties to describe Lightning Experience themes. Each propertyName is case-sensitive and must use all capital letters. Some properties only apply to either Salesforce Lightning Design System (SLDS) 1 themes or SLDS 2 themes.

Property	Description
ACCENT_COLOR_1	Field Type string Description The primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later.
ACCENT_COLOR_2	Field Type string Description A variant of the primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later.
ACCENT_COLOR_3	Field Type string Description A variant of the primary accent color used to highlight active states of the user interface, like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later.
ACCENT_CONTAINER_CONTENT_COLOR_1	Field Type string Description The primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.0 and later.
ACCENT_CONTAINER_CONTENT_COLOR_2	Field Type string Description A variant of the primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.0 and later.
ACCENT_CONTAINER_CONTENT_COLOR_3	Field Type string Description A variant of the primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.0 and later.
BANNER_IMAGE	Field Type string Description The path to the image to display in the background of your org's pages. Use a JPG, PNG, or GIF that's 1800x360 pixels and smaller than 5 MB. Must refer to an asset file that already exists within the org. Available only for SLDS 1 themes.
BRAND_COLOR	Field Type string Description The color to display on your nav bar and other important areas of Salesforce. Must be a valid hex color string in the format #54C254.
BRAND_IMAGE	Field Type string Description The path to the image to display as your logo. Use a JPG, PNG, or GIF that’s 600x120 pixels and smaller than 5 MB. Must refer to an asset file that already exists within the org.
CONTAINER_ACCENT_COLOR_1	Field Type string Description The primary color used for the background of branded component containers like the brand button. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later.
CONTAINER_ACCENT_COLOR_2	Field Type string Description A variant of the primary color used for the background of branded component containers. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later.
CONTAINER_ACCENT_COLOR_3	Field Type string Description A variant of the primary color used for the background of branded component containers. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later.
GROUP_IMAGE	Field Type string Description The default group avatar image. Use a JPG, PNG, or GIF that's 200x200 pixels and smaller than 5 MB. Group owners can change their avatar image. Must refer to an asset file that already exists within the org.
GROUPS_BANNER_IMAGE	Field Type string Description The default banner image for group pages. Use a JPG, PNG, or GIF that’s 1800x360 pixels and smaller than 5 MB. Group owners can change their banner image. Must refer to an asset file that already exists within the org.
HEADER_BACKGROUND_COLOR	Field Type string Description The color to display at the top of your org pages. Your logo, global search, and global actions appear on top of the global header background. Must be a valid hex color string in the format #54C254. Available only for SLDS 1 themes.
LINK_AS_BACKGROUND	Field Type boolean Description Indicates whether you want links in your org to use your selected brand color (`true`) or not (`false`). The default value is `true`. Available only for SLDS 1 themes.
OVERRIDE_A11Y_COLOR	Field Type string Description When you select a value for `BRAND_COLOR`, a color palette that complements your brand color and is WCAG 2.0 compliant is automatically generated. In places where your selected brand color isn’t accessible, an accessible color is used instead. If you provide a value for `OVERRIDE_A11Y_COLOR`, your value is used in the instances described in place of an automatically generated color. Overriding the accessible brand color only updates the first tile in your brand-based color palette, which affects colors like links and buttons. Overriding the accessibility brand color can make text harder to read. Must be a valid hex color string in the format #54C254. Available only for SLDS 1 themes.
OVERRIDE_LOADING_PAGE	Field Type boolean Description Indicates whether your provided brand logo displays while a Lighting Experience page loads or refreshes (`true`) or not (`false`). The default value is `false`.
PAGE_BACKGROUND_COLOR	Field Type string Description The color used for page backgrounds. Must be a valid hex color string in the format #54C254. Available only for SLDS 1 themes.
PROFILE_BANNER_IMAGE	Field Type string Description The default banner image for user profiles. Use a JPG, PNG, or GIF that's 1800x360 pixels and smaller than 5 MB. Users can change their profile banner image. Must refer to an asset file that already exists within the org.
USER_IMAGE	Field Type string Description The default avatar image for user profiles. Use a JPG, PNG, or GIF that's 200x200 pixels and smaller than 5 MB. Users can change their profile avatar image. Must refer to an asset file that already exists within the org.

Declarative Metadata Sample Definition

The following is an example of a BrandingSet component.

1<?xml version="1.0" encoding="UTF-8"?>
2<BrandingSet xmlns="http://soap.sforce.com/2006/04/metadata">
3    <brandingSetProperty>
4        <propertyName>TextTransformStyle</propertyName>
5        <propertyValue>uppercase</propertyValue>
6    </brandingSetProperty>
7    <brandingSetProperty>
8        <propertyName>DetailTextColor</propertyName>
9        <propertyValue>#696969</propertyValue>
10    </brandingSetProperty>
11    <brandingSetProperty>
12        <propertyName>BorderColor</propertyName>
13        <propertyValue>#D4D4D4</propertyValue>
14    </brandingSetProperty>
15    <brandingSetProperty>
16        <propertyName>HeaderImage</propertyName>
17        <propertyValue></propertyValue>
18    </brandingSetProperty>
19    <brandingSetProperty>
20        <propertyName>HeaderFonts</propertyName>
21        <propertyValue>Montserrat</propertyValue>
22    </brandingSetProperty>
23    <brandingSetProperty>
24        <propertyName>CardBackgroundColor</propertyName>
25        <propertyValue>rgba(255, 255, 255, 0)</propertyValue>
26    </brandingSetProperty>
27    <brandingSetProperty>
28        <propertyName>LoginBackgroundColor</propertyName>
29        <propertyValue>#F4F4F4</propertyValue>
30    </brandingSetProperty>
31    <brandingSetProperty>
32        <propertyName>ActionColor</propertyName>
33        <propertyValue>#2574A9</propertyValue>
34    </brandingSetProperty>
35    <brandingSetProperty>
36        <propertyName>_ActionColorTrans</propertyName>
37        <propertyValue>rgba(25, 124, 190, 0.9)</propertyValue>
38    </brandingSetProperty>
39    <brandingSetProperty>
40        <propertyName>CompanyLogo</propertyName>
41        <propertyValue></propertyValue>
42    </brandingSetProperty>
43    <brandingSetProperty>
44        <propertyName>LoginBackgroundImage</propertyName>
45        <propertyValue>../../../../sfsites/picasso/core/external/
46            salesforceIdentity/images/background.jpg?v=1</propertyValue>
47    </brandingSetProperty>
48    <brandingSetProperty>
49        <propertyName>_LinkColorDarker</propertyName>
50        <propertyValue>#135F90</propertyValue>
51    </brandingSetProperty>
52    <brandingSetProperty>
53        <propertyName>_ActionColorDarker</propertyName>
54        <propertyValue>#135F90</propertyValue>
55    </brandingSetProperty>
56    <brandingSetProperty>
57        <propertyName>_HoverColor</propertyName>
58        <propertyValue>rgba(25, 124, 190, 0.1)</propertyValue>
59    </brandingSetProperty>
60    <brandingSetProperty>
61        <propertyName>ErrorFontColor</propertyName>
62        <propertyValue>#ff9e9e</propertyValue>
63    </brandingSetProperty>
64    <brandingSetProperty>
65        <propertyName>TextColor</propertyName>
66        <propertyValue>#333</propertyValue>
67    </brandingSetProperty>
68    <brandingSetProperty>
69        <propertyName>OverlayTextColor</propertyName>
70        <propertyValue>#FFFFFF</propertyValue>
71    </brandingSetProperty>
72    <brandingSetProperty>
73        <propertyName>PrimaryFont</propertyName>
74        <propertyValue>Lato</propertyValue>
75    </brandingSetProperty>
76    <brandingSetProperty>
77        <propertyName>LinkColor</propertyName>
78        <propertyValue>#2574A9</propertyValue>
79    </brandingSetProperty>
80    <masterLabel>ex</masterLabel>
81    <type>napili:branding-napili-merged</type>
82</BrandingSet>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>MyBrandingSet</members>
5        <name>BrandingSet</name>
6    </types>
7    <version>40.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.