Branding Settings Inheritance

Last updated:

This functionality is in beta. By participating in this beta you agree to our beta terms.

Branding theme inheritance allows developers to pull information stored inside Settings > Account Defaults > Branding Tab, including logos, favicons, and color options to use in conjunction with the inherited_value property of theme fields.

Brand Setting Variables

At this time, only brand colors are available to be used in branding theme inheritance. 

The following is a list of options that can be accessed from the Brand Settings area within the value of the property_value_paths object.

brand_settings.primaryColor

The primary color set inside of your brand settings > colors area.

This is an alias of brand_settings.colors[0]

Location of primary branding color
JSON
//Example of using the primary color in brand settings
{
    "name": "branding_color",
    "label": "branding_color",
    "type": "color",
    "default": { 
      "color": "#26ff55", "opacity": 60 
    },
    "inherited_value": {
      "property_value_paths": {
        "color": "brand_settings.primaryColor"
       }
    }
  }

brand_settings.colors[ ]

Additional colors set inside of your brand settings > colors area.

Location of additional branding colors
JSON
//Example of using additional colors in brand settings
{
    "name": "secondary_branding_color",
    "label": "Secondary Branding color",
    "type": "color",
    "default": {
      "color": "#26ff55", "opacity": 60 
    },
    "inherited_value": {
      "property_value_paths": { 
        "color": "brand_settings.colors[3]"
      }
    }
  }

Order of Operations for Brand Inherited Colors

There are times when accounts may not have any additional colors configured inside of the Branding Tab > Colors area. If your code is referencing an inherited color that does not exist in your settings (ex: brand_settings.colors[3]), the default property value will be used as a fallback. If there is no default property color set, the primary color from your brand setting will be used as a fallback instead (brand_settings.primaryColor).


Was this page helpful? *
This form is for feedback on our developer docs. If you have feedback on the HubSpot product, please share it in our Idea Forum instead.