Brand

Description

A brand.

Properties

Property Description
address required nullable

The mailing address for this brand.

created

The creation date of this brand.

customDomain nullable

A custom domain for this brand, if applicable.

email

The email address for this brand.

facebookFanPageUrl nullable

The URL for this brand's Facebook fan page.

galleryDomain

The domain for this brand's galleries.

homepageBrandTheme

A brand theme.

homepageBrandThemeId

The identifier for this brand's homepage brand theme.

id

The identifier for this brand.

instagramUsername nullable

The Instagram username for this brand.

isDefault

Whether this is the default brand for the logged-in user's studio.

labCatalogs

An array of lab catalogs to which this brand has access.

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.

locale

The locale defined for this brand.

name

The name of this brand.

phone

The phone number for this brand.

subdomain

The ShootProof subdomain for this brand.

twitterHandle nullable

The Twitter username for this brand.

type

The type of resource represented.

useDefaultWatermark

Whether or not the Brand's default watermark should be applied at upload time.

website nullable

The URL for this brand's website.

OpenAPI Schema

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

{
  "description": "A brand.",
  "properties": {
    "address": {
      "allOf": [
        {
          "description": "The mailing address for this brand.",
          "nullable": true
        },
        {
          "$ref": "#/components/schemas/Address"
        }
      ]
    },
    "created": {
      "description": "The creation date of this brand.",
      "format": "date-time",
      "type": "string"
    },
    "customDomain": {
      "description": "A custom domain for this brand, if applicable.",
      "format": "hostname",
      "nullable": true,
      "type": "string"
    },
    "email": {
      "description": "The email address for this brand.",
      "format": "email",
      "type": "string"
    },
    "facebookFanPageUrl": {
      "description": "The URL for this brand's Facebook fan page.",
      "format": "uri",
      "nullable": true,
      "type": "string"
    },
    "galleryDomain": {
      "description": "The domain for this brand's galleries.",
      "format": "uri",
      "type": "string"
    },
    "homepageBrandTheme": {
      "$ref": "#/components/schemas/BrandTheme"
    },
    "homepageBrandThemeId": {
      "description": "The identifier for this brand's homepage brand theme.",
      "type": "integer"
    },
    "id": {
      "description": "The identifier for this brand.",
      "type": "integer"
    },
    "instagramUsername": {
      "description": "The Instagram username for this brand.",
      "nullable": true,
      "type": "string"
    },
    "isDefault": {
      "description": "Whether this is the default brand for the logged-in user's studio.",
      "type": "boolean"
    },
    "labCatalogs": {
      "description": "An array of lab catalogs to which this brand has access.",
      "items": {
        "$ref": "#/components/schemas/LabCatalog"
      },
      "title": "Lab Catalog",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "locale": {
      "description": "The locale defined for this brand.",
      "type": "string"
    },
    "name": {
      "description": "The name of this brand.",
      "type": "string"
    },
    "phone": {
      "description": "The phone number for this brand.",
      "type": "string"
    },
    "subdomain": {
      "description": "The ShootProof subdomain for this brand.",
      "type": "string"
    },
    "twitterHandle": {
      "description": "The Twitter username for this brand.",
      "nullable": true,
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "brand"
          ]
        }
      ]
    },
    "useDefaultWatermark": {
      "description": "Whether or not the Brand's default watermark should be applied at\nupload time.",
      "type": "boolean"
    },
    "website": {
      "description": "The URL for this brand's website.",
      "format": "uri",
      "nullable": true,
      "type": "string"
    }
  },
  "title": "Brand",
  "type": "object"
}