Event Photo In Update

OpenAPI Schema

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

{
  "description": "An event photo submitted for updating.\n\nIf replacing the photo—either through full update (`PUT`) or partial\nupdate (`PATCH`)—`filesize`, `randomKey`, and `uploadUrlResponse` are\nall required; `uploadTime` is recommended. Otherwise, they may be\nomitted from the request.",
  "properties": {
    "filesize": {
      "description": "The original filesize of the uploaded event photo.",
      "type": "number"
    },
    "isHidden": {
      "description": "Whether the photo should be marked 'hidden.'",
      "type": "boolean"
    },
    "name": {
      "description": "The filename of the uploaded event photo.",
      "maxLength": 250,
      "type": "string"
    },
    "randomKey": {
      "description": "The random key generated by the client and used to replace the\n`${random_folder}` template variable when uploading the photo using\nthe photo upload policy.",
      "pattern": "^[a-fA-F0-9]{32}$",
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "event-photo"
      ],
      "type": "string"
    },
    "uploadTime": {
      "description": "The time in seconds (as a floating point number) it took to upload\nthe photo to the URL specified in the photo upload policy.",
      "nullable": true,
      "type": "number"
    },
    "uploadUrlResponse": {
      "description": "The response returned as a result of a request to the `.uploadUrl`\nspecified in the photo upload policy.",
      "properties": {
        "contentType": {
          "description": "The value of the response's `Content-Type` header.",
          "type": "string"
        },
        "rawBody": {
          "description": "The raw response body.",
          "type": "string"
        }
      },
      "required": [
        "contentType",
        "rawBody"
      ],
      "type": "object"
    },
    "watermarkId": {
      "description": "The numeric identifier for the watermark applied to this photo, if\napplicable.\n\n_**Please note:** Only provide `watermarkId` if you wish to\nre-watermark the photo. Using an identifier for a different\nwatermark will apply the new watermark to this photo. If the value\nis set to `null` on a photo with a watermark, the watermark will be\nremoved. If the `watermarkId` is not provided, no change will\noccur._",
      "nullable": true,
      "type": "integer"
    }
  },
  "required": [
    "type",
    "name",
    "isHidden"
  ],
  "title": "Event Photo",
  "type": "object"
}