NewEvent

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-new-event-schema.json",
  "title": "NewEvent",
  "description": "CreateEvent",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-altru-event-api-openapi.yml#/components/schemas/NewEvent",
  "required": [
    "name",
    "start_date"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "description": "The name."
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "The description."
    },
    "start_date": {
      "type": "string",
      "description": "The start date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "start_time": {
      "$ref": "#/$defs/HourMinute"
    },
    "end_date": {
      "type": "string",
      "description": "The end date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "end_time": {
      "$ref": "#/$defs/HourMinute"
    },
    "capacity": {
      "type": "integer",
      "description": "The capacity.",
      "format": "int32"
    },
    "main_event_id": {
      "type": "string",
      "description": "The main event."
    },
    "event_location_id": {
      "type": "string",
      "description": "The location."
    },
    "event_location_contact_id": {
      "type": "string",
      "description": "The contact."
    },
    "copy_from_event_id": {
      "type": "string",
      "description": "The copy from."
    },
    "copy_tasks": {
      "type": "boolean",
      "description": "Indicates whether when selected, tasks in the source event will be copied to the new event.."
    },
    "copy_invitations": {
      "type": "boolean",
      "description": "Indicates whether when selected, invitations in the source event will be copied to the new event.."
    },
    "copy_invitees": {
      "type": "boolean",
      "description": "Indicates whether when selected, invitees in the source event will be copied to the new event.."
    },
    "copy_designations": {
      "type": "boolean",
      "description": "Indicates whether when selected, designations in the source event will be copied to the new event.."
    },
    "copy_expenses": {
      "type": "boolean",
      "description": "Indicates whether when selected, expenses in the source event will be copied to the new event.."
    },
    "copy_prices": {
      "type": "boolean",
      "description": "Indicates whether when selected, registration options in the source event will be copied to the new event.."
    },
    "copy_attributes": {
      "type": "boolean",
      "description": "Indicates whether when selected, attributes in the source event will be copied to the new event.."
    },
    "attribute_defined": {
      "type": "boolean",
      "description": "Indicates whether determines if event attributes are defined inorder to display copyattributes.."
    },
    "sites": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewEventSites"
      },
      "description": "Sites."
    },
    "site_required": {
      "type": "boolean",
      "description": "Indicates whether site required. Read-only in the SOAP API."
    },
    "copy_preferences": {
      "type": "boolean",
      "description": "Indicates whether when selected, event preference groups in the source event will be copied to the new event.."
    },
    "event_category": {
      "type": "string",
      "description": "The category. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/eventcategorycode/entries"
    },
    "appeal_id": {
      "type": "string",
      "description": "The appeal."
    },
    "copy_team_structure": {
      "type": "boolean",
      "description": "Indicates whether when selected, teams in the appeal linked to the source event will be copied to the new event.."
    },
    "copy_team_fundraisers": {
      "type": "boolean",
      "description": "Indicates whether when selected, team members in the appeal linked to the source event will be copied to the new event.."
    },
    "copy_lodging_options": {
      "type": "boolean",
      "description": "Indicates whether when selected, event lodging options in the source event will be copied to the new event.."
    },
    "add_quick_compare": {
      "type": "boolean",
      "description": "Indicates whether when selected, make the original event the quick compare event of the copy.."
    },
    "event_location_room": {
      "type": "string",
      "description": "The room/unit. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/5f5a58fe-1594-4004-b0fd-7eb92fb7cf52?parameters=event_location_id,{event_location_id}."
    },
    "copy_job_occurrences": {
      "type": "boolean",
      "description": "Indicates whether when selected, job occurrences in the source event will be copied to the new event.."
    },
    "auction": {
      "type": "boolean",
      "description": "Indicates whether flag used to add extra metadata if the event is an auction.."
    },
    "hide_from_calendar": {
      "type": "boolean",
      "description": "Indicates whether determines whether or not to hide this event from the events calendar.."
    },
    "designations_on_fees": {
      "type": "boolean",
      "description": "Indicates whether determines whether or not event allows designations on fees.."
    },
    "copy_public_description": {
      "type": "boolean",
      "description": "Indicates whether when selected, the web forms description on source event will be copied to the new event.."
    }
  },
  "additionalProperties": false,
  "x-display-name": "Event Add Form",
  "x-display-id": "Event Add Form",
  "$defs": {
    "HourMinute": {
      "type": "object",
      "properties": {
        "hour": {
          "type": "integer",
          "description": "The hour.",
          "format": "int32"
        },
        "minute": {
          "type": "integer",
          "description": "The minute.",
          "format": "int32"
        }
      },
      "description": "HourMinute",
      "x-display-name": "Hour Minute",
      "x-display-id": "Hour Minute"
    },
    "NewEventSites": {
      "required": [
        "site_id"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "id"
        },
        "site_id": {
          "type": "string",
          "description": "site"
        }
      },
      "description": "NewEventSites",
      "x-display-name": "sites",
      "x-display-id": "sites"
    }
  }
}