ONonsched
Appointments

Cancel Appointment

Use this endpoint to Cancel an appointment booking or reservation. Only appointments with a "BK", booked or "RS", reserved status can be cancelled. Past dated appointments cannot be cancelled. A valid appointment id is required. For more information: Appointment Overview

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

Request

Path parameters

idstring required

appointment id to cancel

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

Changes

No recorded changes to this operation across all 1 revision of this API.