---
title: "Cancel Appointment"
method: PUT
path: "/consumer/v1/appointments/{id}/cancel"
tags: ["Appointments"]
---

# Cancel Appointment

`PUT /consumer/v1/appointments/{id}/cancel`

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](https://onsched.readme.io/docs/appointments-overview)

## Path parameters

- `id` string, required

## Response `200`

Success

- AppointmentViewModel
  - `object` string, nullable
  - `id` string, nullable
  - `locationId` string, nullable
  - `businessName` string, nullable
  - `calendarId` string, nullable
  - `serviceId` string, nullable
  - `serviceName` string, nullable
  - `serviceImageUrl` string, nullable
  - `resourceId` string, nullable
  - `resourceName` string, nullable
  - `resourceGroupId` string, nullable
  - `resourceGroupName` string, nullable
  - `resourceImageUrl` string, nullable
  - `resourceEmail` string, nullable
  - `customerId` string, nullable
  - `serviceAllocationId` string, nullable
  - `rescheduledId` string, nullable
  - `createDate` string, nullable
  - `startDateTime` string, nullable
  - `endDateTime` string, nullable
  - `dateInternational` string, nullable
  - `date` string, nullable
  - `time` integer
  - `duration` integer
  - `timezone` integer, nullable
  - `timezoneId` string, nullable
  - `timezoneIana` string, nullable
  - `ipAddress` string, nullable
  - `status` string, nullable
  - `confirmationNumber` string, nullable
  - `downloadIcsUrl` string, nullable
  - `bookedBy` string, nullable
  - `onlineBooking` boolean, nullable
  - `confirmed` boolean
  - `email` string, nullable
  - `name` string, nullable
  - `lastname` string, nullable
  - `firstname` string, nullable
  - `phone` string, nullable
  - `phoneType` string, nullable
  - `phoneExt` string, nullable
  - `customerMessage` string, nullable
  - `notes` string, nullable
  - `groupSize` integer, nullable
  - `lastModifiedOn` string, nullable
  - `lastModifiedBy` string, nullable
  - `emailConfirmationSent` string, nullable
  - `emailReminderSent` string, nullable
  - `smsConfirmationSent` string, nullable
  - `smsReminderSent` string, nullable
  - `location` string, nullable
  - `latitude` string, nullable
  - `longitude` string, nullable
  - `stripeChargeId` string, nullable
  - `stripeRefundId` string, nullable
  - `paymentStatus` integer
  - `resources` AppointmentResourceViewModel[], nullable
    - `appointmentId` string, nullable
    - `resourceId` string, nullable
    - `resourceName` string, nullable
    - `resourceGroupId` string, nullable
    - `resourceEmail` string, nullable
    - `resourceImageUrl` string, nullable
  - `customers` AppointmentCustomerViewModel[], nullable
    - `appointmentId` string, nullable
    - `customerId` string, nullable
  - `customFields` object, nullable
  - `auditTrail` AppointmentAuditViewModel[], nullable
    - `id` string, nullable
    - `appointmentId` string, nullable
    - `modifiedOn` string, nullable
    - `modifiedBy` string, nullable
    - `modificationType` string, nullable
    - `statusBefore` string, nullable
    - `statusAfter` string, nullable
    - `notesBefore` string, nullable
    - `notesAfter` string, nullable

---

[API](https://skmtc.net/onsched/apis/onsched-consumer-api.md) · [All operations](https://skmtc.net/onsched/apis/onsched-consumer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onsched/onsched-consumer-api/versions/1cd2a28a0305/schema)