v1

latestOpenAPI 3.0.02026-07-2673188210.8 KB
host

Add a member to a session waitlist

This endpoint allows staff user to add a member to a session waitlist

NOTE: You can use the optional useBoughtMembershipIds field to provide a list of bought memberships that should be attempted to use during booking from the waitlist. If you don't provide anything here the best matching membership will be used automatically.

ErrorDescription
err-waitlist-not-allowedsession does not have waitlist enabled
err-waitlist-fullsession waitlist is full
err-member-already-on-waitlistmember is already on the waitlist
err-member-not-foundmember not found
err-member-not-assigned-to-hostmember is not assigned to the host
err-session-not-foundsession not found
err-session-not-provided-by-hostsession not provided by the host
err-customer-age-prevents-from-actionmember is not eligible due to age restrictions
err-missing-customer-date-of-birthmember is missing date of birth value
err-missing-date-of-birth-settinghost is missing date of birth settings
err-invalid-date-of-birth-valuemember has invalid date of birth value
post/api/v2/host/sessions/{sessionId}/waitlist/bookings

Path parameters

sessionIdnumber required

Request body

memberIdinteger required
useBoughtMembershipIdsinteger[]

Example request

{
  "memberId": 1,
  "useBoughtMembershipIds": [
    2
  ]
}

Response

waitlistBookingIdinteger required

Example response

{
  "waitlistBookingId": 1
}