Event Collection In Patch

OpenAPI Schema

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

{
  "description": "A collection of events to be updated.",
  "properties": {
    "items": {
      "description": "A collection of one or more batched resources. If `items` is `null`\nor an empty array, no action is taken.",
      "items": {
        "description": "A batch of changes to apply to one or more events.",
        "properties": {
          "brandThemeId": {
            "description": "The identifier for the brand theme the event uses.",
            "nullable": true,
            "type": "number"
          },
          "emailAutomationGroupId": {
            "description": "The identifier for the email automation group associated\nwith the event.",
            "nullable": true,
            "type": "number"
          },
          "eventAccessLevel": {
            "description": "The event access level.",
            "enum": [
              "public-password",
              "public-no-password",
              "private-password",
              "private-no-password"
            ],
            "type": "string"
          },
          "eventCategoryId": {
            "description": "The numeric identifier for the category of this event.",
            "nullable": true,
            "type": "number"
          },
          "eventStatus": {
            "description": "The event status.",
            "enum": [
              "active",
              "inactive",
              "archived"
            ],
            "type": "string"
          },
          "expirationDate": {
            "description": "The date on which this event expires.",
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "headline": {
            "description": "Headline to display to event visitors.",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Identifies one or more resources for which changes may be\napplied. This property accepts several different types of\nvalues:\n\n* `[]`: If the `id` property is an empty array, then the\nchanges will apply to all resources applicable to the context\nof the operation.\n* `number[]`: If the value is an array of integers, then the\nchanges will apply to each of the resources identified by the\nnumbers. If any of these numbers are negative (i.e., prefixed\nwith a minus sign, `-`), the changes will not apply to\nresources identified by those numbers, even if the same number\nis present in the array in its positive form.\n* `null` or _not present_: An undefined state. The changes\nwill not be applied to any resources.\n\nThis functionality allows a great degree of flexibility to\nbatch processing of API resources. We can ask that the changes\nbe applied to all resources for the given `type` by providing\nan empty array. We can apply the changes to all resources\nexcept a few (e.g., `\"id\": [-45, -76, -32]`). We can apply the\nchanges to some resources, but not others (e.g., `\"id\": [-32,\n56, 45, -6, 18, 32]`—in this example, the changes will not be\napplied to the resource identified by `32`).",
            "items": {
              "description": "A positive or negative integer, identifying a resource to\nwhich these changes should or should not (denoted by the\nminus sign) apply.",
              "type": "number"
            },
            "type": "array"
          },
          "information": {
            "description": "Information to display to event visitors.",
            "maxLength": 2000,
            "nullable": true,
            "type": "string"
          },
          "playlistId": {
            "description": "The identifier for the playlist the event uses.",
            "nullable": true,
            "type": "number"
          },
          "priceSheetId": {
            "description": "The identifier for the price sheet the event uses. If\n`null`, then the shopping cart for the event is turned\noff.",
            "nullable": true,
            "type": "number"
          },
          "type": {
            "description": "The type of resource represented (i.e., `event`).",
            "type": "string"
          },
          "videoUrl": {
            "description": "The URL of a video to display to event visitors.",
            "maxLength": 255,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "description": "The model type for the collection object (i.e., `event-collection`).",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Event Collection",
  "type": "object"
}