Newer Version Available

This content describes an older version of this product. View Latest

BrandingSet

Represents a set of branding properties for an Experience Builder site, as defined in the Theme panel in Experience Builder. This object is available in API version 40.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field Details
Description
Type
textarea
Properties
Filter, Nillable, Sort
Description
A description of the branding set.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
Unique name of the branding set.
FullName
Type
string
Properties
Create, Group, Nillable
Description
The full name of the branding set in Metadata API. The full name can include a namespace prefix.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The language of the branding set.
Possible values are:
  • da—Danish
  • de—German
  • en_US—English
  • es—Spanish
  • es_MX—Spanish (Mexico)
  • fi—Finnish
  • fr—French
  • it—Italian
  • ja—Japanese
  • ko—Korean
  • nl_NL—Dutch
  • no—Norwegian
  • pt_BR—Portuguese (Brazil)
  • ru—Russian
  • sv—Swedish
  • th—Thai
  • zh_CN—Chinese (Simplified)
  • zh_TW—Chinese (Traditional)
ManageableState
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The manageable state of the branding set that is contained in a package.
Possible values are:
  • beta—Managed-Beta
  • deleted—Managed-Proposed-Deleted
  • deprecated—Managed-Proposed-Deprecated
  • deprecatedEditable—SecondGen-Installed-Deprecated
  • installed—Managed-Installed
  • installedEditable—SecondGen-Installed-Editable
  • released—Managed-Released
  • unmanaged—Unmanaged
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The user interface name of the branding set.
Metadata
Type
BrandingSet
Properties
Create, Nillable, Update
Description
The branding set's metadata.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

  • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
  • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
Type
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of branding set.
Possible values are:
  • b2b:branding-b2b
  • b2c-lite-storefront:branding
  • citizen:branding-citizen
  • cpt:branding-cpt
  • cypress:branding-cypress
  • ember:branding-ember
  • es-channel-menu
  • helpCenter:branding-helpCenter
  • identity:branding-identity
  • insurance:branding-insurance
  • jepson:branding-jepson
  • koa:branding-koa
  • kokua:branding-kokua
  • login:branding-login
  • login:branding-login2
  • lpi:branding-lpi
  • mfg:branding-mfg
  • mortgage:branding-mortgage
  • napili:branding-napili
  • napili:branding-napili-merged
  • prm:branding-prm-merged
  • service:branding-service
  • starter:branding-starter
  • stella:branding-stella
  • survey
  • talon-template-byo:branding
  • webster:branding-webster

Usage

To work with branding set properties, use BrandingSetProperty.