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 (SDK | REST).

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings - all permissions
Manage Bookings
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>
JavaScript
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?