Brand Homepage

OpenAPI Schema

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

{
  "description": "Brand homepage settings defined for the brand.",
  "properties": {
    "aboutImage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrandHomepageAboutImage"
        },
        {
          "nullable": true
        }
      ]
    },
    "aboutText": {
      "description": "About text defined for the brand.\n\nTypically formatted as HTML.",
      "nullable": true,
      "type": "string"
    },
    "brandTheme": {
      "$ref": "#/components/schemas/BrandTheme"
    },
    "brandThemeId": {
      "description": "The identifier for this brand's homepage brand theme.",
      "type": "integer"
    },
    "enableAboutPage": {
      "description": "Whether to show the about page within the brand homepage.",
      "type": "boolean"
    },
    "enableContactForm": {
      "description": "Whether to show the contact form within the brand homepage.",
      "type": "boolean"
    },
    "eventSortBy": {
      "default": "event-date-desc",
      "description": "The type of sorting to apply when events layout is in use.\n\nEvents can be sorted by name or event date in ascending or descending order.\n\nDefaults to displaying events in descending order by event date.",
      "enum": [
        "event-date-asc",
        "event-date-desc",
        "event-name-asc",
        "event-name-desc"
      ],
      "type": "string"
    },
    "homepageText": {
      "description": "Introductory text that will appear to users when visiting the brand's homepage.\n\nTypically formatted as HTML.",
      "nullable": true,
      "type": "string"
    },
    "layout": {
      "default": "events",
      "description": "The layout option to use for the brand homepage.\n\nNote that the widget layout is only available if it's already in use\nfor the given brand.  Once the layout is using `events` or `categories`,\n`widget` layout cannot be used again.",
      "enum": [
        "events",
        "categories",
        "widget"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "showAddress": {
      "description": "Whether to show the brand's address information.",
      "type": "boolean"
    },
    "showEmail": {
      "description": "Whether to show the brand's email address.",
      "type": "boolean"
    },
    "showHomepageText": {
      "description": "Whether to show introductory text on the brand's homepage.",
      "type": "boolean"
    },
    "showPhone": {
      "description": "Whether to show the brand's phone number.",
      "type": "boolean"
    },
    "showSocialMedia": {
      "description": "Whether to show the brand's social media information.",
      "type": "boolean"
    },
    "showWebsite": {
      "description": "Whether to show the brand's website URL.",
      "type": "boolean"
    },
    "type": {
      "enum": [
        "brand-homepage"
      ],
      "readOnly": true
    },
    "widgetShowEmail": {
      "description": "When using widget layout, whether or not to show the brand's email address.",
      "type": "boolean"
    },
    "widgetShowEventList": {
      "description": "When using widget layout, whether or not to show the brand's event list.",
      "type": "boolean"
    },
    "widgetShowSearch": {
      "description": "When using widget layout, whether or not to show the search field.",
      "type": "boolean"
    }
  },
  "title": "Brand Homepage"
}