NetworkBranding

Represents the branding and color scheme applied to a community. (Salesforce Communities are represented by the Network component.)

This type extends the MetadataWithContent type and inherits its content and fullName fields.

Declarative Metadata File Suffix and Directory Location

NetworkBranding components have the suffix .networkBranding and are stored in the networkBranding folder.

Version

This object is available in API version 41.0 and later. It replaces the Branding subtype in the Network component.

Fields

Field	Field Type	Description
loginFooterText	string	The text that appears in the footer of the community login page.
loginLogo	string	The logo that appears on the community login page for external users.
loginLogoName	string	The name of the logo that appears on the community login page for external users.
loginLogoStaticImageUrl	string	The path to the logo that appears on the community’s login page. This URL can be fixed, dynamic, or an uploaded image. A dynamic URL contains the experience ID parameter, `{expid}`. If the URL contains `{expid}`, the URL is resolved dynamically at runtime depending on the parameter's value.
loginQuaternaryColor	string	The background color for the community’s login page.
loginRightFrameUrl	string	The path to the content of the right frame of the community login page. This URL can be either fixed or dynamic. A dynamic URL contains the experience ID parameter, `{expid}`. If the URL contains `{expid}`, the URL is resolved dynamically at runtime depending on the parameter's value.
network	string	The name of the community associated with the branding.
pageFooter	string	An image that appears on the footer of the community pages. Must be an .html file.
pageHeader	string	An image that appears on the header of the community pages. Can be an .html, .gif, .jpg, or .png file.
primaryColor	string	Required. The color used for the active tab.
primaryComplementColor	string	Required. Font color used with primaryColor.
quaternaryColor	string	Required. The background color for pages in the community.
quaternaryComplementColor	string	Required. Font color used with quaternaryColor.
secondaryColor	string	Required. The color used for the top borders of lists and tables.
tertiaryColor	string	Required. The background color for section headers on edit and detail pages.
tertiaryComplementColor	string	Required. Font color used with tertiaryColor.
zeronaryColor	string	Required. The background color for the header.
zeronaryComplementColor	string	Required. Font color used with zeronaryColor.

Declarative Metadata Sample Definition

A sample XML definition of networkBranding.

1<?xml version="1.0" encoding="UTF-8"?>
2<NetworkBranding xmlns="http://soap.sforce.com/2006/04/metadata">
3    <loginFooterText>salesforce.com</loginFooterText>
4    <loginLogo>Communities_Shared_Document_Folder/header2_png.png</loginLogo>
5    <loginLogoName>header2.png</loginLogoName>
6    <loginQuaternaryColor>#B1BAC1</loginQuaternaryColor>
7    <loginRightFrameUrl>http://www.test.com/test</loginRightFrameUrl>
8    <network>Network 1</network>
9    <pageFooter>Branding/footer_html.html</pageFooter>
10    <pageHeader>Branding/header_Image.jpg</pageHeader>
11    <primaryColor>#AF5800</primaryColor>
12    <primaryComplementColor>#FFFFFF</primaryComplementColor>
13    <quaternaryColor>#286FB8</quaternaryColor>
14    <quaternaryComplementColor>#FFFFFF</quaternaryComplementColor>
15    <secondaryColor>#000000</secondaryColor>
16    <tertiaryColor>#FFFFFF</tertiaryColor>
17    <tertiaryComplementColor>#222222</tertiaryComplementColor>
18    <zeronaryColor>#0A3764</zeronaryColor>
19    <zeronaryComplementColor>#FFFFFF</zeronaryComplementColor>
20</NetworkBranding>

Metadata API Developer Guide

NetworkBranding

Declarative Metadata File Suffix and Directory Location

Version

Fields

Declarative Metadata Sample Definition