Event

OpenAPI Schema

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

{
  "description": "An event.",
  "properties": {
    "albumSortType": {
      "default": "name-asc",
      "description": "The type of sorting to apply to albums in this event.\n\nThis affects only the top-level albums view for the event and\ndoes not cascade down through sub-albums. To apply an album sort\ntype to sub-albums, use a batch update operation on an album\ncollection resource.",
      "enum": [
        "custom",
        "name-asc",
        "name-desc"
      ],
      "type": "string"
    },
    "allowAddAllToCart": {
      "description": "Whether to show \"Buy All\" buttons, allowing clients to add all\nphotos in the event to their cart. If this is set to true, \n`priceSheetShowPackagesOnly` MUST be false.",
      "type": "boolean"
    },
    "allowBlackWhiteFiltering": {
      "description": "Allow clients to see and order a black and white version of an\nimage.",
      "type": "boolean"
    },
    "allowCropping": {
      "description": "Allow clients to crop photos on orders.",
      "type": "boolean"
    },
    "allowFreeDigitals": {
      "description": "Whether to allow clients to download free digitals from the event.",
      "type": "boolean"
    },
    "allowFreeDigitalsDownloadAll": {
      "description": "If `allowFreeDigitals` is true, whether to allow clients to download\nthe entire event.",
      "type": "boolean"
    },
    "allowPayLater": {
      "description": "Whether to allow clients to pay later.",
      "type": "boolean"
    },
    "autoArchiveDays": {
      "description": "If provided, the number of days after event expiration to\nautomatically archive the event.",
      "nullable": true,
      "type": "integer"
    },
    "autoSetAlbumCovers": {
      "description": "Whether to autogenerate album cover images from the first image in\nthe album.",
      "type": "boolean"
    },
    "brandTheme": {
      "$ref": "#/components/schemas/BrandTheme",
      "readOnly": true
    },
    "brandThemeId": {
      "description": "The identifier for the brand theme the event uses.",
      "type": "integer"
    },
    "cartsCount": {
      "description": "The number of active carts with items for this event.",
      "readOnly": true,
      "type": "number"
    },
    "checkoutText": {
      "description": "If provided, a message shown to the client at checkout.",
      "maxLength": 1000,
      "nullable": true,
      "type": "string"
    },
    "contact": {
      "allOf": [
        {
          "description": "The contact associated with this event (if applicable).",
          "nullable": true,
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/EventContact"
        }
      ]
    },
    "contactId": {
      "allOf": [
        {
          "nullable": true
        },
        {
          "$ref": "#/components/schemas/Id"
        }
      ]
    },
    "coverPhoto": {
      "allOf": [
        {
          "description": "A cover photo for the event.",
          "nullable": true,
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/CoverPhoto"
        }
      ]
    },
    "created": {
      "description": "The creation date of this event.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "digitalRules": {
      "description": "Collection of digital rules available for this event. Digital\nrules describe configurations for free digitals downloads.",
      "items": {
        "$ref": "#/components/schemas/DigitalRule"
      },
      "title": "Digital Rule",
      "type": "array"
    },
    "emailAutomationGroupId": {
      "description": "The identifier for the email automation group associated with the\nevent.",
      "nullable": true,
      "type": "integer"
    },
    "eventAccessLevel": {
      "description": "The event access level.",
      "enum": [
        "public-password",
        "public-no-password",
        "private-password",
        "private-no-password"
      ],
      "type": "string"
    },
    "eventCategory": {
      "description": "The human-readable name of the category of the event.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "eventCategoryId": {
      "description": "The category identifier associated with the event.",
      "nullable": true,
      "type": "integer"
    },
    "eventDate": {
      "description": "The date on which this event took place.",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "eventPassword": {
      "description": "If the event access level requires a password, this is the\npassword that must be used to access the event.",
      "maxLength": 30,
      "nullable": true,
      "type": "string"
    },
    "eventPhotoTags": {
      "description": "Photo tags associated with this event.",
      "items": {
        "$ref": "#/components/schemas/EventPhotoTag"
      },
      "readOnly": true,
      "title": "Event Photo Tag",
      "type": "array"
    },
    "eventStatus": {
      "description": "The event status.",
      "enum": [
        "active",
        "inactive",
        "archived"
      ],
      "type": "string"
    },
    "exifSearchFieldLabel": {
      "description": "The label for the EXIF data search field for the event.\n\nThis is only available if the studio has been flagged in the admin\nwith this permission.",
      "maxLength": 40,
      "nullable": true,
      "type": "string"
    },
    "expirationDate": {
      "description": "The date on which this event expired.",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "headline": {
      "description": "Headline to display to event visitors.",
      "maxLength": 100,
      "nullable": true,
      "type": "string"
    },
    "hideAlbums": {
      "description": "Whether to hide all the albums in an event.\n\nThis is only available if the studio has been flagged in the admin\nwith this permission.",
      "type": "boolean"
    },
    "hideAllPhotosAlbum": {
      "description": "Whether to hide the \"All Photos\" default photo album.",
      "type": "boolean"
    },
    "hidePhotoCountAlbums": {
      "description": "Whether to hide the photo count for all albums in the client facing\ngallery.",
      "type": "boolean"
    },
    "homepageLinkTo": {
      "description": "The URL to which the homepage link should send users. This is\nrequired if `showHomepageLink` is `true`.\n\nValid values are:\n\n* `studio_homepage`: The homepage link points to the ShootProof\nhomepage for the brand.\n* `studio_website`: The homepage link points to the website URL set\nfor the brand.",
      "enum": [
        "studio_homepage",
        "studio_website"
      ],
      "nullable": true,
      "type": "string"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "information": {
      "description": "Information to display to event visitors.",
      "maxLength": 2000,
      "nullable": true,
      "type": "string"
    },
    "isPreRegistration": {
      "description": "Whether pre-registration mode is turned on for the event.",
      "type": "boolean"
    },
    "landingLayoutType": {
      "description": "The layout type for the event landing page. The possible landing\nlayout types are:\n\n* `basic`: Accent\n* `full-bottom`: Limelight\n* `full-bottom-alt`: Foundation\n* `full-center`: Marquee\n* `hexagon`: Symmetry\n* `split`: Detail\n* `no-cover`: Headline",
      "enum": [
        "full-bottom",
        "full-center",
        "split",
        "basic",
        "no-cover"
      ],
      "type": "string"
    },
    "languageCode": {
      "description": "The Unicode CLDR language tag for the language used in the event.",
      "type": "string"
    },
    "lastReleasedDate": {
      "description": "The date on which this event was last released. This value is\nonly ever set by the system when the event is released. If the\nevent is released multiple times, this value will always be the\ndate/time that the event was last released.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "minimumOrderAmount": {
      "description": "The minimum amount required for any order placed for the event.",
      "nullable": true,
      "type": "number"
    },
    "musicAutoPlay": {
      "description": "If there is a playlist defined, whether to auto-play the music when\nthe even loads in the browser.",
      "type": "boolean"
    },
    "name": {
      "description": "The name of this event.",
      "maxLength": 100,
      "type": "string"
    },
    "orderDueDate": {
      "description": "The date on which orders for the event are due.",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "ordersCount": {
      "description": "The total number of orders for this event.",
      "readOnly": true,
      "type": "number"
    },
    "photoFavoritesCount": {
      "description": "The number of times photos in this event were favorited.",
      "readOnly": true,
      "type": "number"
    },
    "photoSortType": {
      "default": "name-asc",
      "description": "The type of sorting to apply to photos in this event.\n\nThis affects only the top-level \"all photos\" view for the event\nand does not cascade down through event albums and sub-albums.\nTo apply a photo sort type to all albums and sub-albums, use a\nbatch update operation on an album collection resource.",
      "enum": [
        "custom",
        "name-asc",
        "name-desc",
        "shootDate-asc",
        "shootDate-desc"
      ],
      "type": "string"
    },
    "photosCount": {
      "description": "The total number of photos within this event, including photos\nin albums.",
      "readOnly": true,
      "type": "number"
    },
    "photosInQueueCount": {
      "description": "The total number of photos in the queue to be processed for this\nevent.",
      "readOnly": true,
      "type": "number"
    },
    "photosNotInAnAlbumCount": {
      "description": "Number of photos within this event that are not in any albums.",
      "readOnly": true,
      "type": "number"
    },
    "pickupOptions": {
      "description": "An array of order pickup options supported by the event.",
      "items": {
        "description": "A string identifying a pickup option.",
        "enum": [
          "studio",
          "dropship"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "playlist": {
      "description": "The playlist for the event, if applicable. (TODO: playlists not\nsupported in the API at this time.)",
      "nullable": true,
      "readOnly": true
    },
    "playlistId": {
      "description": "The identifier for the playlist the event uses.",
      "nullable": true,
      "type": "integer"
    },
    "preRegistrationMessage": {
      "description": "Text to display to visitors when the event is in pre-registration\nmode.",
      "maxLength": 1000,
      "nullable": true,
      "type": "string"
    },
    "priceSheet": {
      "description": "The price sheet for the event, if applicable. (TODO: price sheets\nnot supported in the API at this time.)",
      "nullable": true,
      "readOnly": true
    },
    "priceSheetId": {
      "description": "The identifier for the price sheet the event uses. If `null`, then\nthe shopping cart for the event is turned off.",
      "nullable": true,
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "priceSheetShowPackagesOnly": {
      "description": "Whether to limit the display of price sheet items to only those that are packages.\nIf this is set to true, `allowAddAllToCart` MUST be false.",
      "type": "boolean"
    },
    "printRelease": {
      "description": "Print release text that is sent to the client when\nShootProof-fulfilled digitals are downloaded. Some HTML is allowed.",
      "maxLength": 7500,
      "nullable": true,
      "type": "string"
    },
    "releaseDate": {
      "description": "The date on which this event will be released.",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "requireEmail": {
      "description": "Whether an email address is required to view the event.",
      "type": "boolean"
    },
    "shares": {
      "description": "The number of times this event has been shared via various\nchannels.",
      "properties": {
        "facebookCount": {
          "type": "number"
        },
        "linkCount": {
          "type": "number"
        },
        "pinterestCount": {
          "type": "number"
        },
        "twitterCount": {
          "type": "number"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "showExpirationDate": {
      "description": "Whether to show the expiration date to visitors.",
      "type": "boolean"
    },
    "showFilenames": {
      "description": "Whether to show the filenames of photos in the event.",
      "type": "boolean"
    },
    "showHomepageLink": {
      "description": "Whether to show a link to the studio homepage.",
      "type": "boolean"
    },
    "showSocialSharingLinks": {
      "description": "Whether to display social media sharing links for the event.",
      "type": "boolean"
    },
    "socialSharingMessage": {
      "description": "The default message to include when a social sharing link is\nclicked.",
      "maxLength": 93,
      "nullable": true,
      "type": "string"
    },
    "thumbnailGutterWidth": {
      "description": "Relative size of thumbnail gutter width for display.",
      "enum": [
        "s",
        "m",
        "l",
        "xl"
      ],
      "type": "string",
      "x-internal": true
    },
    "thumbnailSize": {
      "description": "Relative size of thumbnails for display.",
      "enum": [
        "s",
        "m",
        "l",
        "xl"
      ],
      "nullable": true,
      "type": "string",
      "x-internal": true
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "event"
      ],
      "type": "string"
    },
    "urlSlug": {
      "description": "The slug used to uniquely identify this event in URLs.",
      "nullable": true,
      "pattern": "^[\\w-]{0,30}$",
      "type": "string"
    },
    "videoUrl": {
      "description": "The URL of a video to display to event visitors.",
      "maxLength": 255,
      "nullable": true,
      "type": "string"
    },
    "viewType": {
      "description": "The layout type for the event photo pages. The possible view types\nare:\n\n* `vmason`: Cascade layout\n* `hmason`: Subway layout",
      "enum": [
        "vmason",
        "hmason"
      ],
      "type": "string"
    },
    "visitorsCount": {
      "description": "The number of event visitors who provided their email address.",
      "readOnly": true,
      "type": "number"
    },
    "visitorsLastActiveDate": {
      "description": "The date on which an event visitor was last active.",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "name",
    "eventDate"
  ],
  "title": "Event",
  "type": "object"
}