Before using this guide you will need a developer account and an access token. You can contact us about creating a developer account here. To get an access token, review the authentication and access tokens guide. You will also need to have booked an appointment and have an appointment_id.
You must include a valid appointment_id in the request body. The optional cancellation_reason_type field can be used to specify a standardized reason. If set to other_patient_reason or other_provider_reason, the cancellation_reason field may also be included to provide additional context.
Cancellable statuses: pending_booking, booking_failed, confirmed, pending_reschedule, reschedule_failed, rescheduled.
If the appointment was booked with a Zocdoc user credential, only that user will have access to view or modify the appointment. If the appointment was booked with a machine-to-machine credential, the appointment can be viewed and modified by any of the developer's machine-to-machine credentials.
- Sandbox
https://api-developer-sandbox.zocdoc.com/v1/appointments/cancel
- Production
https://api-developer.zocdoc.com/v1/appointments/cancel
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-developer-sandbox.zocdoc.com/v1/appointments/cancel \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"appointment_id": "d04b049a-41b1-4aba-9268-d8973cf72cdd",
"cancellation_reason": "string",
"cancellation_reason_type": "patient_no_longer_needs_appointment"
}'