Skip to main content
POST
Create event

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

Event title.

Example:

"Annual Summit"

formattedLocations
string[]

Candidate locations. Each entry needs a city.

Example:
eventDates
string[]

Inclusive date ranges, YYYY-MM-DD.

Example:
venueType
string

Venue type. Defaults to 'hotel'.

numPeople
number

Total attendees.

numHotelRoomsNeeded
number

Guestrooms needed.

meetingRooms
string

Free-text meeting-room requirement.

foodBeverageRequirements
string

Free-text food and beverage needs.

flexibility
string

How firm the dates are, in the requester's own words (e.g. 'can shift a week either way').

accommodations
string[]

Room block per night. One entry per night, each with the room-type split.

Example:
currency
string

ISO currency code. Defaults to 'USD'.

organizationId
number

The organization to create the event under; must be one the acting user belongs to. Ignored on the developer API, where the key already binds an organization.

Response

The created event's id, and how many people can see it

id
string
required

Stable public identifier (UUID) of the created event.

Example:

"3f1a2b4c-5d6e-7f80-9a1b-2c3d4e5f6071"

grantedTo
number
required

How many memberships were granted visibility. Zero means the event exists but nobody can see it yet.

Example:

3