updateNumberOfParticipants( )
Updates the number of participants for a booking.
Description
You can only update the number of participants for class and course bookings, you can't update it for appointment bookings.
Calling this method also changes the
session's
totalNumberOfParticipants
.
When updating the number of participants for a booking you must pass either
participantsChoices
or totalParticipants
. If you pass participantsChoices
for services that have variants,
all of the provided choices must exist for the service. Otherwise, the
call returns an INVALID_SERVICE_CHOICES
error.
This function is not a universal function and runs only on the backend.
This function requires elevated permissions to run. This function is not universal and runs only on the backend.
Syntax
function updateNumberOfParticipants(bookingId: string, options: UpdateNumberOfParticipantsOptions): Promise<UpdateNumberOfParticipantsResponse>
updateNumberOfParticipants Parameters
NAME
TYPE
DESCRIPTION
ID of the booking to update the number of participants for.
Returns
Return Type:
NAME
TYPE
DESCRIPTION
Booking with updated number of participants.
Was this helpful?
updateNumberOfParticipants example
1import { bookings } from 'wix-bookings.v2';23 async function updateNumberOfParticipants(bookingId, options) {4 try {5 const result = await bookings.updateNumberOfParticipants(bookingId, options);67 return result;8 } catch (error) {9 console.error(error);10 // Handle the error11 }12 }13