Skip to Content

The DomainBranding type of the TypeScript SDK, which domains.getBranding and 2 more methods take or answer.

type DomainBranding = {
  brandName: string | null
  domain: string
  hasLogo: boolean
  logoType: string | null
  logoUpdatedAt: number | null
}

Fields

FieldTypeDescription
brandNamestring | nullDisplay name shown with the logo; null = default
domainstringDomain name
hasLogobooleanTrue if a custom logo image has been uploaded
logoTypestring | nullMedia MIME type of the stored logo, or null
logoUpdatedAtnumber | nullEpoch seconds of the last logo write; also acts as cache version

Used by

MethodWhat it does
domains.getBrandingGet domain branding
domains.setBrandingUpdate domain brand name
domains.setLogoUpload domain logo

On this page