Remove Appointment

Request

The record_as_cancelled field controls whether the removal of an appointment is recorded as a cancellation on the patient's record.

When set to true, the appointment is recorded as a cancellation and included in the patient's attendance history.

When set to false, the appointment is removed without affecting the patient's attendance history.

In both cases, the action is recorded in the system audit log.

Security

x-api-key and a-api-key

Path

appointment_idintegerrequired

Bodyapplication/json

appointment_cancellation_reason_idinteger

record_as_cancelledboolean

reasonstring

curl -i -X POST \
  'https://api.pracsuite.com/v1/appointment/{appointment_id}/cancel' \
  -H 'Content-Type: application/json' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "appointment_cancellation_reason_id": 0,
    "record_as_cancelled": true,
    "reason": "string"
  }'

Responses

Successful

Response

No content