--- schema_version: "1" id: 119a0fd8d67e448f3295e4f8d4c9447b717ca8cc6924f9b6f5cc50788883ba07 title: BrandingSet collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_brandingset.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm source_site: developer.salesforce.com content_type: documentation content_hash: 4b74d6b6814baf3dfb4136fc1936d88aa1824776dc1ac7ca9bc0bc5031010f1b description: Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme. --- # BrandingSet Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important 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. ## 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](#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\_1\_DARK\_MODE | Field Type string Description The primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states when a user views Salesforce in dark mode. Must be a valid hex string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.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\_2\_DARK\_MODE | 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 when a user views Salesforce in dark mode. Must be a valid hex string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.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\_COLOR\_3\_DARK\_MODE | 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 when a user views Salesforce in dark mode. Must be a valid hex string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.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\_1\_DARK\_MODE | Field Type string Description The primary color used for the icons and text within accent containers when a user views Salesforce with dark mode enabled. 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\_2\_DARK\_MODE | Field Type string Description A variant of the primary color used for the icons and text within accent containers when a user views Salesforce with dark mode enabled. 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. | | ACCENT\_CONTAINER\_CONTENT\_COLOR\_3\_DARK\_MODE | Field Type string Description A variant of the primary color used for the icons and text within accent containers when a user views Salesforce with dark mode enabled. 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](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) 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](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org. | | BRAND\_IMAGE\_DARK\_MODE | Field Type string Description The path to the image to display as your logo when a user views Salesforce in dark mode. Use a JPG, PNG, or GIF that’s 600x120 pixels and smaller than 5 MB. Must refer to an [asset file](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org. Available only for SLDS 2 themes. Available in API version 65.0 and later. | | 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\_1\_DARK\_MODE | Field Type string Description The primary color used for the background of branded component containers like the brand button when a user views Salesforce in dark mode. 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 65.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\_2\_DARK\_MODE | Field Type string Description A variant of the primary color used for the background of branded component containers when a user views Salesforce in dark mode. 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 65.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. | | CONTAINER\_ACCENT\_COLOR\_3\_DARK\_MODE | Field Type string Description A variant of the primary color used for the background of branded component containers when a user views Salesforce in dark mode. 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 65.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](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) 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](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) 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](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) 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](https://help.salesforce.com/s/articleView?id=experience.admin_files_asset_files.htm&type=5&language=en_US) that already exists within the org. | ## Declarative Metadata Sample Definition The following is an example of a BrandingSet component. TextTransformStyle uppercase DetailTextColor #696969 BorderColor #D4D4D4 HeaderImage HeaderFonts Montserrat CardBackgroundColor rgba(255, 255, 255, 0) LoginBackgroundColor #F4F4F4 ActionColor #2574A9 \_ActionColorTrans rgba(25, 124, 190, 0.9) CompanyLogo LoginBackgroundImage ../../../../sfsites/picasso/core/external/ salesforceIdentity/images/background.jpg?v=1 \_LinkColorDarker #135F90 \_ActionColorDarker #135F90 \_HoverColor rgba(25, 124, 190, 0.1) ErrorFontColor #ff9e9e TextColor #333 OverlayTextColor #FFFFFF PrimaryFont Lato LinkColor #2574A9 ex napili:branding-napili-merged The following is an example package.xml that references the previous definition. MyBrandingSet BrandingSet 40.0 ## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).