{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "branding_properties_for_lightning_experience_themes",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "BrandingSet - Metadata API",
  "description": "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.",
  "file_information": ".brandingSet",
  "directory_location": "brandingSets",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "brandingSetProperty": {
      "type": "BrandingSetProperty[]",
      "description": "An array containing the name and value of each branding property, such as TextColor:#333."
    },
    "description": {
      "type": "string",
      "description": "A description of the set of branding properties."
    },
    "masterLabel": {
      "type": "string",
      "description": "The user interface name of the set of branding properties.",
      "required": true
    },
    "type": {
      "type": "string",
      "description": "The assigned branding set definition for this BrandingSet."
    }
  },
  "branding_properties_for_lightning_experience_themes": {
    "ACCENT_COLOR_1": {
      "type": "string",
      "description": "The primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later."
    },
    "ACCENT_COLOR_2": {
      "type": "string",
      "description": "A variant of the primary accent color used to highlight active states of the user interface like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later."
    },
    "ACCENT_COLOR_3": {
      "type": "string",
      "description": "A variant of the primary accent color used to highlight active states of the user interface, like navigation, tabs, and hover states. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later."
    },
    "ACCENT_CONTAINER_CONTENT_COLOR_1": {
      "type": "string",
      "description": "The primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.0 and later."
    },
    "ACCENT_CONTAINER_CONTENT_COLOR_2": {
      "type": "string",
      "description": "A variant of the primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.0 and later."
    },
    "ACCENT_CONTAINER_CONTENT_COLOR_3": {
      "type": "string",
      "description": "A variant of the primary color used for the icons and text within accent containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 65.0 and later."
    },
    "BANNER_IMAGE": {
      "type": "string",
      "description": "The path to the image to display in the background of your org's pages. Use a JPG, PNG, or GIF that's 1800x360 pixels and smaller than 5 MB. Must refer to an asset file that already exists within the org. Available only for SLDS 1 themes."
    },
    "BRAND_COLOR": {
      "type": "string",
      "description": "The color to display on your nav bar and other important areas of Salesforce. Must be a valid hex color string in the format #54C254."
    },
    "BRAND_IMAGE": {
      "type": "string",
      "description": "The path to the image to display as your logo. Use a JPG, PNG, or GIF that’s 600x120 pixels and smaller than 5 MB. Must refer to an asset file that already exists within the org."
    },
    "CONTAINER_ACCENT_COLOR_1": {
      "type": "string",
      "description": "The primary color used for the background of branded component containers like the brand button. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later."
    },
    "CONTAINER_ACCENT_COLOR_2": {
      "type": "string",
      "description": "A variant of the primary color used for the background of branded component containers. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later."
    },
    "CONTAINER_ACCENT_COLOR_3": {
      "type": "string",
      "description": "A variant of the primary color used for the background of branded component containers. Container accent colors are also used for hover states for branded component containers. Must be a valid hex color string in the format #54C254. Available only for SLDS 2 themes. Available in API version 64.0 and later."
    },
    "GROUP_IMAGE": {
      "type": "string",
      "description": "The default group avatar image. Use a JPG, PNG, or GIF that's 200x200 pixels and smaller than 5 MB. Group owners can change their avatar image. Must refer to an asset file that already exists within the org."
    },
    "GROUPS_BANNER_IMAGE": {
      "type": "string",
      "description": "The default banner image for group pages. Use a JPG, PNG, or GIF that’s 1800x360 pixels and smaller than 5 MB. Group owners can change their banner image. Must refer to an asset file that already exists within the org."
    },
    "HEADER_BACKGROUND_COLOR": {
      "type": "string",
      "description": "The color to display at the top of your org pages. Your logo, global search, and global actions appear on top of the global header background. Must be a valid hex color string in the format #54C254. Available only for SLDS 1 themes."
    },
    "LINK_AS_BACKGROUND": {
      "type": "boolean",
      "description": "Indicates whether you want links in your org to use your selected brand color (true) or not (false). The default value is true. Available only for SLDS 1 themes."
    },
    "OVERRIDE_A11Y_COLOR": {
      "type": "string",
      "description": "When you select a value for BRAND_COLOR, a color palette that complements your brand color and is WCAG 2.0 compliant is automatically generated. In places where your selected brand color isn’t accessible, an accessible color is used instead. If you provide a value for OVERRIDE_A11Y_COLOR, your value is used in the instances described in place of an automatically generated color. Overriding the accessible brand color only updates the first tile in your brand-based color palette, which affects colors like links and buttons. Overriding the accessibility brand color can make text harder to read. Must be a valid hex color string in the format #54C254. Available only for SLDS 1 themes."
    },
    "OVERRIDE_LOADING_PAGE": {
      "type": "boolean",
      "description": "Indicates whether your provided brand logo displays while a Lighting Experience page loads or refreshes (true) or not (false). The default value is false."
    },
    "PAGE_BACKGROUND_COLOR": {
      "type": "string",
      "description": "The color used for page backgrounds. Must be a valid hex color string in the format #54C254. Available only for SLDS 1 themes."
    },
    "PROFILE_BANNER_IMAGE": {
      "type": "string",
      "description": "The default banner image for user profiles. Use a JPG, PNG, or GIF that's 1800x360 pixels and smaller than 5 MB. Users can change their profile banner image. Must refer to an asset file that already exists within the org."
    },
    "USER_IMAGE": {
      "type": "string",
      "description": "The default avatar image for user profiles. Use a JPG, PNG, or GIF that's 200x200 pixels and smaller than 5 MB. Users can change their profile avatar image. Must refer to an asset file that already exists within the org."
    }
  },
  "sub_types": {
    "BrandingSetProperty": {
      "propertyName": {
        "type": "string",
        "description": "The name of the branding property, such as TextColor.",
        "required": true
      },
      "propertyValue": {
        "type": "string",
        "description": "The value of the branding property, such as #333."
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"BrandingSet\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"brandingSetProperty\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BrandingSetProperty\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"type\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"BrandingSetProperty\">\n  <xsd:sequence>\n    <xsd:element name=\"propertyName\" type=\"xsd:string\"/>\n    <xsd:element name=\"propertyValue\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of a BrandingSet component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<BrandingSet xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <brandingSetProperty>\n        <propertyName>TextTransformStyle</propertyName>\n        <propertyValue>uppercase</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>DetailTextColor</propertyName>\n        <propertyValue>#696969</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>BorderColor</propertyName>\n        <propertyValue>#D4D4D4</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>HeaderImage</propertyName>\n        <propertyValue></propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>HeaderFonts</propertyName>\n        <propertyValue>Montserrat</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>CardBackgroundColor</propertyName>\n        <propertyValue>rgba(255, 255, 255, 0)</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>LoginBackgroundColor</propertyName>\n        <propertyValue>#F4F4F4</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>ActionColor</propertyName>\n        <propertyValue>#2574A9</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>_ActionColorTrans</propertyName>\n        <propertyValue>rgba(25, 124, 190, 0.9)</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>CompanyLogo</propertyName>\n        <propertyValue></propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>LoginBackgroundImage</propertyName>\n        <propertyValue>../../../../sfsites/picasso/core/external/\n            salesforceIdentity/images/background.jpg?v=1</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>_LinkColorDarker</propertyName>\n        <propertyValue>#135F90</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>_ActionColorDarker</propertyName>\n        <propertyValue>#135F90</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>_HoverColor</propertyName>\n        <propertyValue>rgba(25, 124, 190, 0.1)</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>ErrorFontColor</propertyName>\n        <propertyValue>#ff9e9e</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>TextColor</propertyName>\n        <propertyValue>#333</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>OverlayTextColor</propertyName>\n        <propertyValue>#FFFFFF</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>PrimaryFont</propertyName>\n        <propertyValue>Lato</propertyValue>\n    </brandingSetProperty>\n    <brandingSetProperty>\n        <propertyName>LinkColor</propertyName>\n        <propertyValue>#2574A9</propertyValue>\n    </brandingSetProperty>\n    <masterLabel>ex</masterLabel>\n    <type>napili:branding-napili-merged</type>\n</BrandingSet>"
    }
  ]
}