CustomBrandAsset

Represents a branding element in a custom branding scheme. For example, a color, logo image, header image, or footer text. A CustomBrandAsset can apply to a community or to an org using the Salesforce app. This object is available in API version 28.0 and later.

Supported Calls

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

Special Access Rules

This object is available only if Salesforce Communities is enabled in your organization.

Fields

Field Name Details
AssetCategory
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Values include:
  • MotifZeronaryColor—The background color for the header. Label is Zeronary motif color.

    If this CustomBrandAsset is for a network, this is the header color for the network. If it is for an org, this is the header color when users access the Salesforce app.

  • MotifPrimaryColor—The color used for the active tab. Label is Primary motif color.

    Not used for the Salesforce app branding.

  • MotifSecondaryColor—The color used for the top borders of lists and tables. Label is Secondary motif color.

    Not used for the Salesforce app branding.

  • MotifTertiaryColor—The background color for section headers on edit and detail pages. Label is Tertiary motif color.

    Not used for the Salesforce app branding.

  • MotifQuaternaryColor—If this CustomBrandAsset is for a network, this is the background color for network pages. If it is for an org, this is the background color on a splash page. Label is Quaternary motif color.
  • MotifZeronaryComplementColor—Font color used with zeronaryColor. Label is Zeronary motif colors complement color.
  • MotifPrimaryComplementColor—Font color used with primaryColor. Label is Primary motif colors complement color.

    Not used for the Salesforce app branding.

  • MotifTertiaryComplementColor—Font color used with tertiaryColor. Label is Tertiary motif colors complement color.

    Not used for the Salesforce app branding.

  • MotifQuaternaryComplementColor—Font color used with quaternaryColor. Label is Quaternary motif colors complement color.

    Not used for the Salesforce app branding.

  • PageHeader—An image that appears on the header of the community pages. Can be an .html, .gif, .jpg, or .png file. Label is Page Header.

    Not used for the Salesforce app branding.

  • PageFooter—An image that appears on the footer of the community pages. Must be an .html file. Label is Page Footer.

    Not used for the Salesforce app branding.

  • LoginFooterText—The text that appears in the footer of the community login page. Label is Footer text displayed on the login page.

    Not used for the Salesforce app branding.

  • LoginLogoImageId—The logo that appears on the community login page for external users. In the Salesforce app, this logo also appears on the community splash page. Label is Logo image displayed on the login page.
  • LargeLogoImageId—Only used for the Salesforce app. The logo that appears on the splash page when you start the Salesforce app. Label is Large logo image.
  • SmallLogoImageId—Only used for the Salesforce app. The logo that appears on the publisher in the Salesforce app. Label is Small logo image.
  • StaticLogoImageURL—The logo that appears on the community login page for external users. Label is Static logo image url.
  • LoginQuaternaryColor—The background color that appears on the community login page for external users. Label is Login background color.
  • LoginRightFrameUrl—The URL to the contents that appears on right side of the community login page for external users. Label is Login right frame url.
  • LogoAssetId—ID of the document, if the logo is uploaded to the Documents folder. The logo appears on the login page community login page for external users. Label is Logo asset image.
AssetSourceId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description

ID of the document uploaded to the Documents folder if the value of AssetCategory is PageHeader, PageFooter, or LoginLogoImageId.

CustomBrandId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the associated CustomBrand.
ForeignKeyAssetId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description

This field was removed in API version 41.0, and is available in earlier versions for backward compatibility only. Use AssetSourceId instead.

ID of the document used if the AssetCategory is PageHeader, PageFooter, or LoginLogoImageId.

TextAsset
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
Text used if the AssetCategory is LoginFooterText.

Usage

Use this object to add basic branding elements—color scheme, header or footer images, login page logo, or footer text—to the branding scheme (CustomBrand) for your Network. You must have “Create and Manage Communities” to customize community branding.

If you’re using communities in the Salesforce app, the loading page shows the logo.

See Also