updateNumberOfParticipants( )

Updates the number of participants for a class or course booking and changes the totalNumberOfParticipants for the relevant sessions.

Appointment limitation

You can't update the number of participants for appointment bookings.

Participant information

You must specify either participantsChoices or totalParticipants. The call fails if the specified participantsChoices aren't among the supported service options and variants.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

In Wix sites and Wix apps, use elevated permissions.
In Wix Headless projects, use API key authentication.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

bookingIdstringRequired

ID of the booking to update the number of participants for.

optionsUpdateNumberOfParticipantsOptions

Returns

Return Type:Promise<UpdateNumberOfParticipantsResponse>

Errors

404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?