BrandingSet

Represents the definition of a set of branding properties for a community, as defined in the Branding Panel in Community Builder. This type extends the Metadata metadata type and inherits its fullName field.

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 object is available when at least one of the following is enabled in your org: Salesforce Communities, Surveys, or Lightning Experience .

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 Branding panel in Community Builder.

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`.

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>

Metadata API Developer Guide