NetworkBranding | Metadata API Developer Guide

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

For branding properties that apply to Experience Builder sites, see BrandingSet.

Note

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
loginBackgroundImageUrl	string	The path to the image URL that appears as the background on the Experience Cloud site’s login page. This URL can be fixed, dynamic, or an uploaded image. A dynamic URL contains the experience ID parameter, `{expid}`, and is resolved dynamically at runtime.
loginFooterText	string	The text that appears in the footer of the Experience Cloud site login page.
loginLogo	string	The logo that appears on the Experience Cloud site login page for external users.
loginLogoName	string	The name of the logo that appears on the Experience Cloud site login page for external users.
loginPrimaryColor	string	The background color of the Login button. Available in API version 42.0 and later.
loginQuaternaryColor	string	The background color for the Experience Cloud site’s login page.
loginRightFrameUrl	string	The path to the content of the right frame of the Experience Cloud site 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 Experience Cloud site associated with the branding.
pageFooter	string	An image that appears on the footer of the Experience Cloud site pages. Must be an .html file.
pageHeader	string	An image that appears on the header of the Experience Cloud site 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 Experience Cloud site.
quaternaryComplementColor	string	Required. Font color used with quaternaryColor.
secondaryColor	string	Required. The color used for the top borders of lists and tables.
staticLogoImageUrl	string	The path to the logo that appears on the Experience Cloud site’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.
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 network branding.

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    <loginBackgroundImageUrl>http://identitycms.herokuapp.com/promo-background.jpg</loginBackgroundImageUrl>
7    <loginQuaternaryColor>#B1BAC1</loginQuaternaryColor>
8    <loginRightFrameUrl>https://www.example.com/test</loginRightFrameUrl>
9    <network>Network 1</network>
10    <pageFooter>Branding/footer_html.html</pageFooter>
11    <pageHeader>Branding/header_Image.jpg</pageHeader>
12    <primaryColor>#AF5800</primaryColor>
13    <primaryComplementColor>#FFFFFF</primaryComplementColor>
14    <quaternaryColor>#286FB8</quaternaryColor>
15    <quaternaryComplementColor>#FFFFFF</quaternaryComplementColor>
16    <secondaryColor>#000000</secondaryColor>
17    <tertiaryColor>#FFFFFF</tertiaryColor>
18    <tertiaryComplementColor>#222222</tertiaryComplementColor>
19    <zeronaryColor>#0A3764</zeronaryColor>
20    <zeronaryComplementColor>#FFFFFF</zeronaryComplementColor>
21</NetworkBranding>

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.