rescheduleBooking( )


Reschedules an appointment booking to a different slot or a class booking to a different session.

Course booking limitation

You can't reschedule course bookings.

Appointment sessions

For appointments, the old session is removed from the business calendar while a new session is added. We recommend calling Query Availability (SDK | REST) first and specifying the entire retrieved slot.

Class sessions

For classes, the new session must be an existing session belonging to the same class. We recommend retrieving availabilityEntries.slot.eventId from Query Availability (SDK | REST) to avoid failed Reschedule Booking calls due to unavailability. Specify only slot.eventId instead of the entire slot object.

Notify customers

You can specify a participantNotification.message for the customer. To send the message, you must also specify participantNotification.notifyParticipants as true.

Admin overwrites

There are small but important differences when you specify special flowControlSettings:

  • {"ignoreReschedulePolicy": true}: The call succeeds even if the service's reschedulePolicy doesn't allow it.
  • {"skipAvailabilityValidation": true}: The call succeeds even if the specified session, slot, or resource isn't available. If you don't specify any resource, the call succeeds even if no resource of the relevant type is available.
  • {"skipBusinessConfirmation": true}: Any PENDING booking is automatically confirmed even if the services requires the merchants's manual confirmation.

When using special flowControlSettings, ensure you have sufficient permissions. If you encounter failed calls due to insufficient permissions, consider the following options:

  • App developers can use a higher permission, such as MANAGE BOOKINGS - ALL PERMISSIONS.
  • Site developers can utilize elevation.

Granting additional permissions and using elevation permits method calls that would typically fail due to authorization checks. Therefore, you should use them 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 reschedule.


slotV2SlotRequired

New slot of the booking.


optionsRescheduleBookingOptions

An object representing the available options for rescheduling a booking.

Returns
Return Type:Promise<RescheduleBookingResponse>
Errors
400Invalid Argument

There is 1 error with this status code:

403Permission Denied

There are 3 errors with this status code:

404Not Found

There is 1 error with this status code:

428Failed Precondition

There are 11 errors with this status code:

See the entire list and learn more about Wix errors.

Did this help?