Brand Theme

Description

A brand theme.

Properties

Property Description
colorScheme

The color scheme for this brand theme.

ShootProof Identifier Description
dark A "dark" color scheme should be used when displaying this brand theme.
light A "light" color scheme should be used when displaying this brand theme.
created read-only

The date on which the entity was created.

emailBrandLogo nullable

The brand logo for use in email messages (and any other place using a white/neutral background such as contracts and invoices).

eventBrandLogo nullable

The brand logo for use in event presentation.

fontSet

The font set for this brand theme.

ShootProof Identifier Primary Font Name Secondary Font Name Body Font Name
brandon Brandon Brandon Baskerville
freeland ProximaNova Freeland ProximaNova
baskerville Baskerville Baskerville OpenSans-Regular
blooming-elegant BloomingElegant-Regular BloomingElegant-Regular Brandon
bambusa-pro-regular BambusaPro-Regular BambusaPro-Regular OpenSans-Regular
scandiebox-one SBOne SBOne OpenSans-Regular
id

The identifier of this brand theme.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

name

The name of this brand theme.

primaryColor

The primary hex color code for this brand theme.

secondaryColor

The secondary hex color code for this brand theme.

type

The type of object represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A brand theme.",
  "properties": {
    "colorScheme": {
      "description": "The color scheme for this brand theme.\n\n| ShootProof Identifier | Description |\n| --------------------- | ----------- |\n| `dark` | A \"dark\" color scheme should be used when displaying this brand theme. |\n| `light` | A \"light\" color scheme should be used when displaying this brand theme. |",
      "enum": [
        "dark",
        "light"
      ],
      "type": "string"
    },
    "created": {
      "$ref": "#/components/schemas/Signature/properties/created"
    },
    "emailBrandLogo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrandLogo"
        },
        {
          "nullable": true
        }
      ],
      "description": "The brand logo for use in email messages (and any other place using\na white/neutral background such as contracts and invoices)."
    },
    "eventBrandLogo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrandLogo"
        },
        {
          "nullable": true
        }
      ],
      "description": "The brand logo for use in event presentation."
    },
    "fontSet": {
      "description": "The font set for this brand theme.\n\n| ShootProof Identifier | Primary Font Name | Secondary Font Name | Body Font Name |\n| --------------------- | ----------------- | ------------------- | -------------- |\n| `brandon` | Brandon | Brandon | Baskerville |\n| `freeland` | ProximaNova | Freeland | ProximaNova |\n| `baskerville` | Baskerville | Baskerville | OpenSans-Regular |\n| `blooming-elegant` | BloomingElegant-Regular | BloomingElegant-Regular | Brandon |\n| `bambusa-pro-regular` | BambusaPro-Regular | BambusaPro-Regular | OpenSans-Regular |\n| `scandiebox-one` | SBOne | SBOne | OpenSans-Regular |",
      "enum": [
        "brandon",
        "freeland",
        "baskerville",
        "blooming-elegant",
        "bambusa-pro-regular",
        "scandiebox-one"
      ],
      "type": "string"
    },
    "id": {
      "description": "The identifier of this brand theme.",
      "type": "integer"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of this brand theme.",
      "type": "string"
    },
    "primaryColor": {
      "description": "The primary hex color code for this brand theme.",
      "example": "777777",
      "type": "string"
    },
    "secondaryColor": {
      "description": "The secondary hex color code for this brand theme.",
      "example": "ffffff",
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "brand-theme"
      ],
      "type": "string"
    }
  },
  "type": "object"
}