Events

Create Event

Create a new event.

The host is automatically resolved from your API key. Provide an address to auto-geocode the location.

By default the event is created as a draft. Pass publish=true to create and publish it as live in one step — ticket sales open immediately, default reminders are created, and the host receives a notification email.

post/v1/events

Request

  • Base URL: https://developer.eventship.com (the document declares no server; this is the origin it was published from)
  • URL: https://developer.eventship.com/v1/events
  • Auth: API key in header X-API-Key

Request body

titlestring required
startDatestring date-time required
descriptionstring nullable
endDatestring date-time nullable

When the event ends, in the event's timezone. Optional: omit it and the event is created lasting four hours from its start, which you can change at any time with a PATCH.

timezonestring
locationType'in_person' | 'virtual' | 'hybrid' | 'global'

How guests attend an event.

venuestring nullable
addressstring nullable
virtualLinkstring nullable
externalRegistrationUrlstring nullable
privateLocationboolean
isPublicboolean
showGuestListboolean
imagestring nullable
bannerTemplatestring nullable
introductionsEnabledboolean
sendSaveTheDateboolean
feedbackEnabledboolean nullable
enableAdsboolean
publishboolean

If true, the event is published immediately as live instead of remaining a draft.

Response

Successful Response

successboolean
messagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.