Search...
Generate a test token to explore our APIs
Register to Waitlist
Developer Preview
Registers a site member to a waitlist. If the requested session does not have a waitlist, or if the waitlist is already full, an error is received.
Permissions
This endpoint requires the Manage Bookings permissions scope
Syntax
function Registerto Waitlist 1(waitingResource: string, formInfo: _com_wix_bookings_api_v1_FormInfo, presentedStartTime: _com_wix_bookings_schedules_api_v1_LocalDateTime, presentedEndTime: _com_wix_bookings_schedules_api_v1_LocalDateTime): Register<_com_wix_bookings_api_v1_RegisterResponse>
Register to Waitlist Parameters
NAME
TYPE
DESCRIPTION
waitingResource
Required
string
Resource to be waitlisted for. Currently only supports session ID.
formInfo
Required
object
Participant information as filled in the booking form (required). Contains contact details and other form fields specified by the owner for this 'waiting resource' (service).
presentedStartTime
object
Service start time as presented to the user. For validation - Optional.
presentedEndTime
object
Service end time presented to the user. For validation - Optional.
Returns
Return Type:
object
NAME
TYPE
DESCRIPTION
registrationId
string
Was this helpful?
Register to waitlist
Adds a contact details to a wait list and return its registration Id.
Request
curl
Copy Code
1curl --X POST /2 'https://www.wixapis.com/bookings/v1/waitlist/register' \3 -H 'Authorization: <AUTH>'4 --data '{5 "waitingResource": "193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1VRioAcbF7zzwvoBTEIScx8fykHVtU2r5GoJrd7PuRidnB3zvYGeB6vu46SF7RN6M20Jg3OP1PZhRjhbotC5iz5mBXEncK2sHCaVgGczVpDEUts19ULscMtZ8dzmp6Hd6caRs6g5UcGtKSnvH5KJPYdojijsgantqsSTmGCItRoTcYi0dBhYzvxxB6Sv51iSs7tupi36hkw6Eau5FhC7P8jBQfZ0eFi7tZIeGUyoV39wexfMbu0kLn5nRTUVx5r0eSzENSJcV7F",6 "formInfo": {7 "paymentSelection": [8 {9 "rateLabel": "general",10 "numberOfParticipants": 111 }12 ],13 "contactDetails": {14 "email": "Doh@Doh.com",15 "firstName": "Homer",16 "lastName": "Simpson",17 "phone": "5558707"18 }19 }20 }'
Response
json
12{"registrationId": "2724acf6-fedd-402b-8cbc-48bc784481d9"}