Skip to main content

BrandDetails

Details about a brand and the configuration information we have for them.

type BrandDetails {
assets: [BrandAssetDetails!]!
brandFeatureConfiguration: BrandFeatureConfigurationPayload
brandSupportConfiguration: BrandSupportConfigurationPayload
colors: BrandColors
displayName: LocalizedText
emailFooter: LocalizedText
logo: BrandAssetDetails
logoMobile: BrandAssetDetails
name: String!
}

Fields

BrandDetails.assets ● [BrandAssetDetails!]! non-null object

Any assets the brand currently has stored.

BrandDetails.brandFeatureConfiguration ● BrandFeatureConfigurationPayload object

Brand feature configuration.

BrandDetails.brandSupportConfiguration ● BrandSupportConfigurationPayload object

Brand support configuration.

BrandDetails.colors ● BrandColors object

Color palette information for the brand.

BrandDetails.displayName ● LocalizedText object

The user-friendly display name for the brand as a record with SupportedLanguage as keys, translated strings as values.

BrandDetails.emailFooter ● LocalizedText object

A record with SupportedLanguage for keys and localized email footer text for values.

BrandDetails.logo ● BrandAssetDetails object

Metadata about a brand's logo, its alt text/description, where it's stored within cloud storage, and a public url for download.

BrandDetails.logoMobile ● BrandAssetDetails object

Metadata about a brand's mobile logo, similar to logo.

BrandDetails.name ● String! non-null scalar

The name of the brand. This is a unique identifier.

Returned by

currentUserBrandDetails query