DELETE

Delete Appointment

Permanently deletes an appointment.

DELETEhttps://api.vantaxai.com/v1/appointments/{appointment_id}

If the appointment is mirrored to a connected external calendar, the corresponding event is removed there as well. To keep a historical record instead of deleting, update the `status` to `cancelled`.

Irreversible

Deleting an appointment removes it from the connected external calendar and cannot be undone. Consider setting `status` to `cancelled` if you need to retain the record.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…

Path Parameters

appointment_idstringrequired
The appointment to delete.
example: appt_7c1d90

Request

curl -X DELETE https://api.vantaxai.com/v1/appointments/appt_7c1d90 \
  -H "Authorization: Bearer vx_live_3fa9c2..."

const res = await fetch(
  "https://api.vantaxai.com/v1/appointments/appt_7c1d90",
  {
  method: "DELETE",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
  },
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// DELETE /v1/appointments/{appointment_id}
const result = await vantax.request("DELETE", "/v1/appointments/{appointment_id}");

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# DELETE /v1/appointments/{appointment_id}
result = vantax.request("DELETE", "/v1/appointments/{appointment_id}")

Response

{
  "success": true,
  "message": "Appointment deleted successfully"
}

{ "success": false, "message": "Appointment not found" }