updateNumberOfParticipants( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates the number of participants for a booking.

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.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings
Manage Bookings - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
bookingIdstringRequired

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

optionsUpdateNumberOfParticipantsOptions
Returns
Return Type:Promise<UpdateNumberOfParticipantsResponse>
Was this helpful?
Yes
No