v1

latestOpenAPI 3.0.12026-07-133870165.8 KB

Appointments

Reschedule Appointment

Use this endpoint to Reschedule an appointment booking. Only appointments in "BK", booked status, can be Rescheduled. Past dated appointments cannot be rescheduled. A valid appointment id is required.

The StartDateTime and EndDateTime are required. Use the ISO 8601 format for DateTime Timezone, e.g., 2016-10-30T09:00:00-5:00.

The serviceId is optional. If changing the serviceId, the new service id's duration must match the original service's duration.

The resourceId is optional. If changing the resourceId, verify the availability of the new resource prior to rescheduling.

IMPORTANT: Always run availability before rescheduling an appointment to verify the timeslot is open and available for the new time, service and/or resource requested. This is the only way to assure the slot is available. You cannot reschedule an appointment to a different location. If necessary, you should cancel and then book an appointment in the other location.

For more information: Appointment Overview

put/consumer/v1/appointments/{id}/reschedule

Path parameters

idstring required

appointment id to reschedule

Request body

serviceIdstring nullable

resourceIdstring nullable

resourceIdsstring nullable

startDateTimestring date-time

endDateTimestring date-time

travelTimeMinsinteger

travelAppointmentIdstring nullable

Response

Success

objectstring nullable

idstring nullable

locationIdstring nullable

businessNamestring nullable

calendarIdstring nullable

serviceIdstring nullable

serviceNamestring nullable

serviceImageUrlstring nullable

resourceIdstring nullable

resourceNamestring nullable

resourceGroupIdstring nullable

resourceGroupNamestring nullable

resourceImageUrlstring nullable

resourceEmailstring nullable

customerIdstring nullable

serviceAllocationIdstring nullable

rescheduledIdstring nullable

createDatestring nullable

startDateTimestring nullable

endDateTimestring nullable

dateInternationalstring nullable

datestring nullable

timeinteger

durationinteger

timezoneinteger nullable

timezoneIdstring nullable

timezoneIanastring nullable

ipAddressstring nullable

statusstring nullable

confirmationNumberstring nullable

downloadIcsUrlstring nullable

bookedBystring nullable

onlineBookingboolean nullable

confirmedboolean

emailstring nullable

namestring nullable

lastnamestring nullable

firstnamestring nullable

phonestring nullable

phoneTypestring nullable

phoneExtstring nullable

customerMessagestring nullable

notesstring nullable

groupSizeinteger nullable

lastModifiedOnstring nullable

lastModifiedBystring nullable

emailConfirmationSentstring nullable

emailReminderSentstring nullable

smsConfirmationSentstring nullable

smsReminderSentstring nullable

locationstring nullable

latitudestring nullable

longitudestring nullable

stripeChargeIdstring nullable

stripeRefundIdstring nullable

paymentStatusinteger

customFieldsobject nullable