Reschedules an appointment booking to a different slot or a class booking to a different session.
You can also call this method to update the list of add-ons associated with the booking. To do so, both of these conditions must be met:
flowControlSettings.allowAddOnChanges set to true.BOOKINGS.MANAGE_ADDONS permissions and specify flowControlSettings.allowAddOnChanges as true.You can't reschedule course bookings.
For appointments, the old session is removed from the business calendar
while a new session is added. We recommend calling Query Availability
first and specifying the entire retrieved slot.
For classes, the new session must be an existing session belonging to the
same class. We recommend retrieving availabilityEntries.slot.eventId
from Query Availability
to avoid failed Reschedule Booking calls due to unavailability. Specify
only slot.eventId instead of the entire slot object.
You can specify a participantNotification.message for the customer. To send
the message, you must also specify participantNotification.notifyParticipants
as true.
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:
MANAGE BOOKINGS - ALL PERMISSIONS.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.
There is 1 error with this status code.
There are 3 errors with this status code.
There is 1 error with this status code.
There are 15 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.