Skip to main content
POST
Join waitlist

Authorizations

Authorization
string
header
required

Your brand's secret API key, e.g. Bearer way_sk_live_bhEqcn0i1fRoUEHBPjJkQA. Older Way-Brand-Id + Way-Secret-Key credentials still work: see Legacy authentication.

Path Parameters

brandId
string
required

The brand's ID - must match the brand your API key identifies (or the Way-Brand-Id header when one is sent).

waitlistId
string
required

The waitlist's ID, from the listing or experience data.

Body

application/json
sessionStartDate
string
required

Date of the sold-out session to join the waitlist for, in YYYY-MM-DD format.

Pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
Example:

"2026-07-18"

sessionStartTime
string
required

Start time of the session, in the property's local time (HH:mm or HH:mm:ss).

Pattern: ^([0-1]\d|2[0-3])(?::([0-5]\d)){1,2}$
Example:

"10:00"

sessionDuration
number
required

Length of the session in minutes.

Example:

60

purchaser
object
required

The guest joining the waitlist. They receive the booking invitation when capacity opens up.

participants
object[]
required

Guests to include in the waitlist entry. At least one participant is required.

Minimum array length: 1

Response

201

Join waitlist.