This topic outlines the properties within the event schema and its referenced sub-schemas, providing a categorized breakdown for clarity and understanding.

Core Event Information

The following properties define the fundamental aspects of an event.

  • name (string): The unique name of the event within an account. Minimum length 1, maximum length 100.
  • title (string): The display title for the event. This does not need to be unique. Maximum length 100.
  • description (string): A detailed description of the event. Minimum length 0, maximum length 600.
  • event_type (string): Identifies the category of the event. Examples: CLASSES_WORKSHOPS, PERFORMING_ARTS, CONFERENCES_SEMINARS_FORUM, MUSIC_CONCERTS, etc.
  • event_id (string, UUID format): The unique identifier for the event.
  • campaign_id (string, UUID format): A system-assigned ID that is generally identical to the event_id and that uniquely identifies the event.
  • status (string): The current state of the event. Possible values: DRAFT, ACTIVE, CANCELED, COMPLETE.

Event Timing and Scheduling

The following properties detail the event’s schedule and temporal characteristics.

  • event_start (string, ISO format): The starting date and time of the event.
  • event_end (string, ISO format): The ending date and time of the event.
  • time_zone (string): The time zone where the event takes place. Example: US/Eastern.
  • time_zone_abbreviation (string): The abbreviated time zone (read-only). Example: EST.
  • create_time (string, ISO format): The timestamp when the event was created (read-only).
  • last_update_time (string, ISO format): The timestamp when the event was last modified.
  • active_time (string, ISO format): The timestamp when the event was published (read-only).
  • cancelled_time (string, ISO format): The timestamp when the event was cancelled (read-only).
  • deleted_time (string, ISO format): The timestamp when the event was deleted (read-only).

Location and Address Information

The following properties describe where the event will take place.

  • location_type (string): Specifies the nature of the event’s location. Possible values: BOTH (physical and virtual), PHYSICAL, TBA (To Be Announced), VIRTUAL.

AddressDto

address (AddressDto object): Contains detailed physical address information.

  • address_type (string): The type of address (currently only EVENT is supported).
  • line1 and line2 (string): Location address lines where the event takes place.
  • city (string): City where the event takes place.
  • country (string): Name of the country.
  • country_code (string): Two-letter country code. For example US.
  • latitude (number, float): Geographical latitude where the event takes place.
  • longitude (number, float): Geographical longitude where the event takes place.
  • location_name (string): The name of the venue where the event takes place.
  • postal_code (string): Postal code where the event takes place.
  • state (string): State or Province name.
  • state_code (string): Two-letter state code.
  • create_time and *last_update_time* (string, ISO format): Timestamps for location address creation and modification.

Contact and Communication

The following properties relate to the event’s contact person and communication settings.

ContactDto object

contact (ContactDto object): Details about the event’s contact.

  • name (string): The contact person’s name.
  • organization_name (string): The organization associated with the contact.
  • email_address (string): Email to use for replies and notifications.
  • from_email_address (string): Email to use for sending confirmation emails.
  • phone_number (string): The contact phone number.
  • create_time and last_update_time (string, ISO format): Timestamps for contact creation and modification.
  • display_contact_flag (boolean): Indicates whether contact information displays on the registration form.
  • notify_owner_on_reg (boolean): If true, sends an email to the event owner upon new registration.

Registration and Ticketinq

The following properties manage the registration process and ticket configurations.

TrackDto

default_track (TrackDto object): Contains default settings for event tracks, particularly related to registration and tickets.

  • campaign_activity_id (string, UUID format): ID for the registration form’s campaign activity (read-only).
  • conf_email_campaign_activity_id (string, UUID format): ID for the confirmation email’s campaign activity (read-only).
  • registration_type (string): The method of registration. Possible values: TICKET, RSVP.
  • reg_manually_closed_flag (boolean): If true, manually closes the registration.
  • platform_fee_scope_type (string): Determines who pays the platform fee. Possible values: REGISTRANT, OWNER.
  • overall_ticket_capacity (integer): The total number of tickets available.
  • restrict_to_single_ticket_flag (boolean): If true, limits selection to one ticket.
  • tickets_header (string): The header text to use for tickets.
  • items_header (string): The header text to use for add-ons.
  • registration_end_time (string, ISO format): The date and time when registration closes.

PromoCodeDto

promo_codes (array of PromoCodeDto objects): A list of promotional codes available for the event.

  • name (string): The name of the promo code.
  • description (string): Description of the promo code.
  • discount_amount (number): The fixed discount amount.
  • discount_percent (integer): The percentage discount.
  • discount_code_type (string): Type of discount (AMOUNT or PERCENT).
  • discount_code_scope (string): Scope of the discount (TICKET_LIST or ORDER_TOTAL).
  • start_time, end_time (string, ISO format): Validity period of the promo code.
  • quantity_total (integer): Total number of promo codes to accept.
  • quantity_available (integer): Number of promo codes still available.
  • quantity_used (integer): Number of promo codes already used.
  • paused_flag (boolean): If true, pauses the promo code.
  • time_limit_flag (boolean): Indicates if a time limit applies.
  • status (string): Current status of the promo code.

ItemSummaryDto

items (array of ItemSummaryDto objects): Items associated with the promo code.

  • item_id (string): Unique ID for the item.
  • name (string): Name of the item.
  • associated (boolean): If true, item is associated with promo code.
  • display_item_on_promo_redemption (boolean): If true, displays item on promo code redemption.
  • hidden_flag (boolean): If true, hides the item.

TicketSummaryDto

tickets (array of TicketSummaryDto objects): Tickets associated with the promo code.

  • ticket_id (string): Unique ID for the ticket.
  • name (string): Name of the ticket.
  • ticket_type (string): Type of ticket (FREE or PAID).
  • associated (boolean): If true, ticket is associated with promo code.
  • display_ticket_on_promo_redemption (boolean): If true, displays ticket on promo code redemption.
  • hidden_flag (boolean): If true, hides the ticket.

ItemDto

items (array of ItemDto objects): Configured items for the event.

  • item_id (string): Unique identifier for the item.
  • name (string): Name of the item.
  • description (string): Description of the item.
  • price (number): Price per item.
  • quantity_total (integer): Total items available.
  • quantity_remaining (integer): Items still available.
  • quantity_sold (integer): Total items sold.
  • limit_per_order (integer): Maximum items per order.
  • show_remaining_flag (boolean): Displays remaining items to customers.
  • paused_flag (boolean): If true, pauses item sales.
  • deletable_flag (boolean): If true, item can be deleted (read-only).
  • media_internal_id (string): Internal ID for item’s image.
  • media_url (string): URL to use for item’s media.
  • time_limit_flag (boolean): If true, item has time-based availability.
  • start_time, end_time (string, ISO format): Item availability period.
  • hidden_flag (boolean): If true, hides the item from customers.
  • deleted_time (string, ISO format): When the item was deleted.

StatusDisplayLabelDto

status_labels (array of StatusDisplayLabelDto objects): Display labels for item status.

  • label (string): The text to display for the status. For example, “Available” or “Sold out”.
  • label_key (string): The translation key that applies to the status. For example, status_label.available

AttributeDto

attributes (array of AttributeDto objects): Additional attributes for the item.

  • attribute_id (string): Unique identifier for the attribute.
  • name (string): Name of the attribute. For example: Size.
  • quantity_total (integer): Total quantity for this attribute.
  • quantity_remaining (integer): Remaining quantity for this attribute.
  • quantity_sold (integer): Quantity sold for this attribute.
  • paused_flag (boolean): If true, pauses sales for this attribute.
  • deleted_time (string, ISO format): When the attribute was deleted.

StatusDisplayLabelDto

status_labels (array of StatusDisplayLabelDto objects): Display labels for attribute status.

  • create_time, last_update_time (string, ISO format): Timestamps for attribute creation and modification.
  • display_order (integer): Order to display the attribute.

Event Display and URLs

The following properties control how the event displays and provides relevant links.

  • display_map_on_lp_flag (boolean): If true, displays a map on the landing page.
  • display_end_time_flag (boolean): If true, displays the event end time.
  • display_time_zone_flag (boolean): If true, displays the time zone.
  • display_on_calendar_flag (boolean): If true, displays the event on the calendar.
  • event_calendar_url (string): The URL for the event calendar (read-only).
  • event_widget_url (string): The URL for the event widget (read-only).
  • registration_url (string): The URL for event registration (read-only).
  • eso (string): The encrypted System Object ID (SOId) which is (read-only).

Payment Configuration

The following properties relate to currency and payment processing for the event.

PaymentConfigurationDto

Details for payment processing.

  • currency_type (string): The currency used for payments.
  • enum: [ AUD, BRL, CAD, CHF, CZK, DKK, EUR, GBP, HKD, HUF, ILS, JPY, MXN, MYR, NOK, NZD, PHP, PLN, RUB, SEK, SGD, THB, TRY, TWD, USD ]
  • payment_instructions (string): Instructions for each payment option. For example WEPAY instructions.
    • enum: [WEPAY, PAYPAL, CHECK, DOOR, STRIPE]
  • payment_option_configurations oneOf:PaymentOptionConfigurationDto, CheckPaymentOptionConfigurationDto, OnlinePaymentOptionConfigurationDto, PayPalPaymentConfigurationDto

PaymentOptionConfigurationDto

payment_option_configurations (array of PaymentOptionConfigurationDto objects): Base configuration for event payment options.

  • payment_option (string): Type of payment option.
    • enum: [WEPAY, PAYPAL, CHECK, DOOR, STRIPE]
  • visible (boolean): If true, the payment option is visible.
  • selected (boolean): If true, the payment option is selected by default.
  • additional_accounts (boolean): If true, additional accounts are available.
  • error_messages (array of Message objects): Associated error messages.
  • create_time and last_update_time (string, ISO format): Create and update timestamps for payment configuration.
  • payment_account_id (string, UUID format): Unique ID for the payment account.

AdditionalPaymentOptionConfigurationDto

  • additional_payment_option_configurations (array of AdditionalPaymentOptionConfigurationDto objects): Additional payment option configurations.
    • payment_option (string): Type of additional payment option.

      • payment_option_configurations (array): Additional payment option configurations (PaymentOptionConfigurationDto, CheckPaymentOptionConfigurationDto, OnlinePaymentOptionConfigurationDto, PayPalPaymentConfigurationDto.

        • PaymentOptionConfigurationDto (object): Base configuration for payment options in an event.
          • create_time (string, ISO format): Create time of the event. `
          • last_update_time (string, ISO format): Last modification time of the event.
          • payment_account_id (string, ISO format): The unique identifier for the payment account.
          • payment_option (string) The payment option type.
            • enum: [WEPAY, PAYPAL, CHECK, DOOR, STRIPE]
          • visible* (boolean): Specifies if the payment option is visible to users.
          • selected* (boolean): Specifies if the payment option is selected by default.
          • additional_accounts: Specifies if additional accounts are available.
          • error_messages (array): List of error messages associated with the payment option.
        • OnlinePaymentOptionConfigurationDto (object):
          • allOf (object):
            • $ref: PaymentOptionConfigurationDto
            • properties:
              • email_address (string)
      • PayPalPaymentConfigurationDto: (object):
        • allOf (object):
          • $ref: PaymentOptionConfigurationDto
          • properties:
            • email_address (string)
            • venmo_enabled (boolean)
            • pay_later (boolean)
      • CheckPaymentOptionConfigurationDto:
        • allOf (object):
          • $ref: PaymentOptionConfigurationDto
          • properties:
            • payable_to (string): The name to make the check payable too.

EventPlatformFeeConfigurationBaseDto object)

  • platform_fee_configuration (EventPlatformFeeConfigurationBaseDto object): Details for platform fees.
    • currency_type (string): Currency for the platform fee.
    • exempt (boolean): If true, the platform fee is exempt.
    • flat_rate_component (number): Flat rate component of the fee.
    • percent_component (number): Percentage component of the fee.
    • last_refreshed_time (string, ISO format): Timestamp for last refresh.
    • platform_fee_instruction_keys (array of strings): Instruction keys for platform fees.
    • platform_fee_scope_type (string): Determines who pays the platform fee (REGISTRANT or OWNER).

    • PaymentAddressDto

    • payment_address (PaymentAddressDto object): The address for payment-related information. Includes typical address fields similar to AddressDto, but specifically for payments.

Event Metadata and Settings

The following properties provide additional configurations and informational flags.

EventMetaDataDto

event_metadata (EventMetaDataDto object): Includes additional event information.

  • items_enabled (boolean): If true, items are enabled for the event.
  • paid_event (boolean): If true, the event requires payment.
  • promo_codes_enabled (boolean): If true, promo codes are enabled.

EventSettingsDto

event_settings (EventSettingsDto object): Event-specific settings.

  • event_requires_payments (boolean): If true, the event is configured for payments.
  • item_configured (boolean) : If true, items exist for the event.
  • online_payment_configured (boolean): If true, online payment is configured.
  • payment_configured (boolean): If true, payment is configured.
  • promo_code_configured (boolean) : If true, promo codes are configured.
  • ticket_configured (boolean) : If true, ticketing is configured.

Event Promotions

The following properties describe promotions associated with the event.

EventPromotionDto

event_promotions (array of EventPromotionDto objects): List of event promotions (read-only).

  • assoc_activity_sub_type (string): Type of associated activity, such as EMAIL_INVITATION or CAMPAIGN_EMAIL.
  • campaign_activity_id (string, UUID format): Unique ID for the campaign activity.
  • document_id (string, UUID format): Unique ID for the document.
  • ext_id (string, UUID format): External identifier.
  • default (boolean): If true, this is the default promotion.

Online (Virtual) Meeting Details

The following properties are relevant for virtual events.

OnlineMeetingDto

online_meeting (OnlineMeetingDto object): Information for a virtual event’s online meeting.

  • enabled_flag (boolean): If true, online meeting is enabled.
  • instructions (string): Instructions for joining the meeting.
  • label (string): Label for the online meeting.
  • provider_type (string): Type of online meeting provider. Examples: ZOOM, GOTOMEETING, TEAMS, WEBEX, OTHER.
  • url (string): The URL for the online meeting.
  • create_time and last_update_time (string, ISO format): Timestamps for online meeting creation/modification.

Other Identifiers and Flags

  • account_id (string): The customer’s account ID.
  • event_code (string): A short code for the event.
  • failed_campaign_activities (array of strings, UUID format): List of campaign activity IDs that failed (read-only).
Tags: events