Skip to main content
PATCH
Update event

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The event's public id (UUID).

Body

application/json
name
string

Event title.

Example:

"Annual Summit"

venueFacingEventName
string

What hotels are told the event is called. Null or blank falls back to the event name.

Example:

"Offsite"

eventDates
object

Ranked date options, best first. Each is a range {startDate, endDate} or a single day {date, startTime?, endTime?}. Written as sent; never derived from the room block.

Example:
venueTypes
string[]

Venue types: hotel, resort, restaurant, bar, nightclub, event_space, airbnb, airbnb_experiences, airbnb_services, vacation_rental, other. Unknown values are dropped; an empty list keeps the stored value.

Example:
meetingRoomCountsByDate
object

Meeting rooms needed per agenda day, keyed YYYY-MM-DD. Days outside the agenda ranges are dropped.

Example:
meetingRoomRequirements
object

General session and breakout requirements: {generalSession, breakout}.

agenda
object

The complete agenda, replacing what is stored. Cannot be sent with agendaOperations.

customQuestions
string[]

Questions for the venue, one per entry. Writes the same column as notesForVenue; send one or the other.

customConcessions
string[]

Concessions to ask the venue for.

eventSource
string

How the event was found: google-search, referral-word-of-mouth, previous-client, social-media, industry-event, partner-vendor, website, advertisement, other. Null clears it.

eventSourceOtherText
string

Free text, used when the event source is 'other'.

notesLocationBudget
string

Notes on location and budget.

formattedLocations
object

Candidate locations. Each entry needs a city.

Example:
numPeople
number

Total attendees.

Example:

300

budgetBreakdown
object

Budget totals keyed by category: venue, fb, av, transport, flight, activities, merch, other.

Example:
flexibility
string

Date flexibility. Send the exact string 'Dates not flexible' for no, free text for yes, or null if unanswered.

decisionDeadline
string

ISO 8601 timestamp for the venue decision deadline.

Example:

"2026-09-01T00:00:00.000Z"

accommodations
object

Guestroom counts per night, keyed YYYY-MM-DD. Room types: Single, Double, Twin, ROH, Suite, Staff, VIP.

Example:
meetingRoomDates
object

Agenda date ranges, both ends inclusive.

Example:
numMeetingRoomsNeeded
number

Separate meeting rooms needed.

numHotelRoomsNeeded
number

Total guestrooms the event needs.

Example:

40

foodBeverageRequirements
string

Food and beverage notes.

meetingRooms
string

Meeting room notes.

otherNotes
string

Additional notes.

notesForVenue
string

Notes shown to the venue.

decisionFactors
string[]

What drives the venue decision.

Example:
decisionFactorOtherText
string

Free text, used when 'Other' is among the decision factors.

additionalServices
string[]

Extra services requested.

Example:
agendaOperations
object

Agenda session changes, addressed by session id so a single edit need not restate the whole agenda.

Example:

Response

The event's refreshed details, ready to read back and re-send

id
string
required

Stable public identifier (UUID).

Example:

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

name
string
required
Example:

"Annual Summit"

status
string
required

Planning status.

Example:

"wait_for_proposals"

currency
string
required

ISO 4217 currency code.

Example:

"USD"

location
string
required

Derived from formattedLocations. Read-only.

Example:

"Austin, TX, USA"

eventDates
object[]
required

Derived from the union of guestroom nights and agenda ranges. Read-only.

formattedLocations
object[]
required
numPeople
number
required

Total attendees.

Example:

300

budgetBreakdown
object
required

Budget line item → amount, in currency.

Example:
flexibility
string | null
required

How firm the dates are, in the requester's own words.

Example:

"Can shift a week either way"

decisionDeadline
string | null
required
Example:

"2026-12-01"

accommodations
object
required

Room block: night (YYYY-MM-DD) → counts per room type (Single, Double, Twin, ROH, Suite, Staff, VIP).

Example:
meetingRoomDates
object[]
required
agenda
object[]
required
numMeetingRoomsNeeded
number | null
required
Example:

3

numHotelRoomsNeeded
number | null
required
Example:

40

foodBeverageRequirements
string | null
required
Example:

"Buffet lunch both days"

meetingRooms
string | null
required
Example:

"Two breakouts of 50"

otherNotes
string | null
required
Example:

"Bring badges"

notesForVenue
string | null
required
decisionFactors
string[]
required
Example:
decisionFactorOtherText
string | null
required
additionalServices
string[]
required
Example: