Appointment Deletion

This endpoint allows you to delete an appointment. While this is a delete endpoint, the appointment will actually be set to status=CANCELLED. If the appointment was previously confirmed, this will send an email to the employee assigned to the appointment notifying them of the appointment cancellation.

DELETE

/api/v2/appointments/:appointment_id

Response

Example responseJSON200 · application/json

{
"data": {
  "message": "success",
  "notification_sent": true
}
}

Appointment Not Found

Below is an example error response. In this example, attempting to delete an appointment which does not exist.

Error responseJSON404 · application/json

{
"errors": {
  "appointment": {"id": "Appointment id=890 does not exist"}
}
}