v1

latestSwagger 2.0Private2026-08-04128286690.5 KB

Events

POST (create) a new event.

Creates a new event with default settings, registration form, and landing page. The event will be created in DRAFT status.

post/events/default

Query parameters

namestring

Name for the new event. If not provided, a default name will be generated.

start_timestring

Event start time in ISO 8601 format. If not provided, defaults to a future date.

end_timestring

Event end time in ISO 8601 format. If not provided, defaults to one hour after start time.

placeholder_campaign_idstring

Placeholder campaign ID for the event.

Response

Event created successfully

descriptionstring required

Provides the event description.

titlestring required

The title for the event. The title does not have to be unique for an account.

namestring required

The name of the event, has to be unique for the account.

event_idstring uuid

The ID that uniquely identifies the event.

campaign_idstring uuid required

The system assigned ID that uniquely identifies the event and is identical to the event_id.

event_startstring required

The date the event starts.

event_endstring required

The date the event ends.

event_typestring required

Identifies the event type.

esostring

The encrypted SOId.

create_timestring

The time the event was created, in ISO format. Read-only.

active_timestring

The time the event was published, in ISO format.

cancelled_timestring

The time the event was cancelled, in ISO format. Read-only.

deleted_timestring

The time the event was deleted, in ISO format. Read-only.

last_update_timestring

The date and time the event was last modified.

currency_typestring

The accepted currency for payments. Required for events collecting payments ['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']

display_contact_flagboolean

Display or hide event contact information on the registration form and registration confirmation message.

display_end_time_flagboolean

Display or hide the event end time on the registration form and registration confirmation message.

display_on_calendar_flagboolean

Display the event on the Event Calendar.

display_time_zone_flagboolean

Display the time zone on the registration form and registration confirmation message.

event_calendar_urlstring

The event calendar URL.

event_codestring

The short code to use for the event.

event_widget_urlstring

The event widget URL.

failed_campaign_activitiesstring[]

List of failed campaign activities.

location_typestring required

Specifies if the event is physical and/or virtual, or to be determined.

notify_owner_on_regboolean

If true, sends an email to the event owner when a registration is made.

registration_urlstring

The event registration URL.

statusstring

Specifies the event's current status.

time_zonestring required

The time zone where the event takes place.

time_zone_abbreviationstring

The abbreviation to use to indicate the time zone where the event takes place.

Example response

{
  "description": "It's time for the High-Class Reunion. A night of reminiscing, networking, and celebrating shared success amongst old friends.",
  "title": "Riverdale High - Class of 2015 Reunion",
  "name": "Class of 2015 Reunion",
  "event_id": "05cf4d60-56ea-4023-bf49-b35e56a9c7b5",
  "campaign_id": "05cf4d60-56ea-4023-bf49-b35e56a9c7b5",
  "event_start": "2023-12-01T20:30:00Z",
  "event_end": "2023-12-01T21:30:00Z",
  "event_type": "PERFORMING_ARTS",
  "eso": "001wQREZJ98vGM_rGt-fbtpGw==",
  "contact": {
    "create_time": "2023-11-17T17:33:21.652Z",
    "email_address": "john.doe@aol.com",
    "from_email_address": "john.doe@aol.com",
    "last_update_time": "2023-12-07T13:18:39.681Z",
    "name": "John Doe",
    "organization_name": "Doe Orchards",
    "phone_number": "781 265 8956"
  },
  "create_time": "2023-11-17T17:33:21.652Z",
  "active_time": "2023-11-17T17:33:21.655Z",
  "cancelled_time": "2023-11-17T17:33:21.655Z",
  "deleted_time": "2023-11-17T17:33:21.655Z",
  "last_update_time": "2023-12-07T13:18:39.681Z",
  "address": {
    "address_type": "EVENT",
    "line1": "100 Seaport Blvd",
    "line2": "100 Seaport Blvd",
    "city": "Boston",
    "country": "United States",
    "country_code": "US",
    "create_time": "2023-11-17T17:33:21.652Z",
    "last_update_time": "2023-12-07T13:18:39.681Z",
    "latitude": 42.629368,
    "longitude": -71.27594,
    "location_name": "Holiday Market at Snowport",
    "postal_code": "02451",
    "state": "Queensland",
    "state_code": "MA"
  },
  "currency_type": "USD",
  "default_track": {
    "campaign_activity_id": "31bb0c22-1c72-4841-9d2c-8bd41ed526bc",
    "conf_email_campaign_activity_id": "31bb0c22-1c72-4841-9d2c-8bd41ed526bc",
    "create_time": "2023-11-17T17:33:21.652Z",
    "items_header": "Items",
    "last_update_time": "2023-12-07T13:18:39.681Z",
    "media_assets": [
      {
        "create_time": "2023-11-17T17:33:21.652Z",
        "external_id": "123456",
        "internal_id": "123456",
        "last_update_time": "2023-12-07T13:18:39.681Z",
        "media_type": "BNR"
      }
    ],
    "overall_ticket_capacity": 100,
    "platform_fee_scope_type": "OWNER",
    "promo_codes": [
      {
        "name": "WIN95",
        "end_time": "2026-11-17T17:33:21.652Z",
        "deleted_time": "2023-11-17T17:33:21.652Z",
        "description": "JAN_PROMO",
        "discount_amount": 10,
        "discount_code_scope": "ORDER_TOTAL",
        "discount_code_type": "PERCENT",
        "discount_percent": 20,
        "id": "123456",
        "items": [
          {
            "item_id": "item123",
            "name": "T-shirt"
          }
        ],
        "quantity_available": 500,
        "quantity_total": 1000,
        "start_time": "2026-11-10T17:33:21.652Z",
        "status_labels": [
          {
            "label": "Available",
            "label_key": "status_label.available"
          },
          {
            "label": "Sold out",
            "label_key": "status_label.sold_out"
          }
        ],
        "tickets": [
          {
            "name": "VIP Ticket",
            "ticket_id": "TICKET123",
            "ticket_type": "PAID",
            "display_ticket_on_promo_redemption": true,
            "hidden_flag": true
          }
        ]
      }
    ],
    "reg_manually_closed_flag": true,
    "registration_end_time": "2024-01-01T20:30:00Z",
    "registration_type": "TICKET",
    "restrict_to_single_ticket_flag": true,
    "tickets_header": "Tickets",
    "track_id": "s8zabc",
    "items": [
      {
        "create_time": "2023-11-17T17:33:21.652Z",
        "last_update_time": "2023-12-07T13:18:39.681Z",
        "item_id": "ITEM123",
        "display_order": 1,
        "name": "VIP Ticket",
        "description": "Premium access to all event areas.",
        "price": 25,
        "quantity_total": 100,
        "quantity_remaining": 50,
        "quantity_sold": 50,
        "limit_per_order": 2,
        "paused_flag": true,
        "deletable_flag": true,
        "media_internal_id": "rqla5y1",
        "media_url": "https://example.com/media/image.jpg",
        "start_time": "2025-04-17T20:00:00.000Z",
        "end_time": "2025-05-17T20:00:00.000Z",
        "deleted_time": "2024-05-17T20:00:00.000Z",
        "status_labels": [
          {
            "label": "Sold out",
            "label_key": "status_label.available"
          }
        ],
        "attributes": [
          {
            "create_time": "2023-11-17T17:33:21.652Z",
            "last_update_time": "2023-12-07T13:18:39.681Z",
            "attribute_id": "attr123",
            "display_order": 1,
            "name": "Size",
            "quantity_total": 100,
            "quantity_remaining": 20,
            "quantity_sold": 40,
            "deleted_time": "2025-05-01T00:00:00.000Z",
            "status_labels": [
              {
                "label": "Sold out",
                "label_key": "status_label.available"
              }
            ]
          }
        ]
      }
    ]
  },
  "display_contact_flag": true,
  "display_end_time_flag": true,
  "display_on_calendar_flag": true,
  "display_time_zone_flag": true,
  "event_calendar_url": "https://lp.constantcontactpages.com/ev/calendar/001wZREXJ98vGM_rGt-fbtpGw==",
  "event_metadata": {
    "items_enabled": true,
    "paid_event": true,
    "promo_codes_enabled": true
  },
  "event_code": "EVENT124",
  "event_promotions": [
    {
      "assoc_activity_sub_type": "EMAIL_INVITATION",
      "campaign_activity_id": "123e4567-e89b-12d3-a456-426614174000",
      "document_id": "123e4567-e89b-12d3-a456-426614174000",
      "ext_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "event_settings": {
    "event_requires_payments": true,
    "ticket_configured": true
  },
  "event_widget_url": "https://eventsfeed.constantcontact.com/widget/myevents.js?eso=001wZREXJ98vGM_rGt-fbtpGw==",
  "location_type": "PHYSICAL",
  "notify_owner_on_reg": true,
  "online_meeting": {
    "create_time": "2023-11-17T17:33:21.652Z",
    "last_update_time": "2023-12-07T13:18:39.681Z",
    "provider_type": "ZOOM",
    "url": "https://meet.google.com/abc-defg-hij"
  },
  "registration_url": "https://l1.constantcontactpages.com/ev/reg/scrk2u2",
  "status": "ACTIVE",
  "time_zone": "US/Eastern",
  "time_zone_abbreviation": "EST"
}