ZOzocdoc
appointments

Cancel appointment

This endpoint is used to request the cancellation of an appointment in a non-cancelled status. (Non-cancelled statuses include: pending_booking, booking_failed, confirmed, pending_reschedule, reschedule_failed and rescheduled)

Developers must send a valid appointment_id as input in the request body and may choose to pass a cancellation reason using the standardized cancellation_reason_type field. The optional cancellation_reason field should only be used when the cancellation reason type is 'other_patient_reason' or 'other_provider_reason' to provide additional context.

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.

post/v1/appointments/cancel

Request

  • Base URL
    https://api-developer-sandbox.zocdoc.com
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.appointment.write
    • or OAuth 2
      Authorization code: https://auth.zocdoc.com/authorize
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.appointment.write

Request body

appointment_idstring required

The Zocdoc ID of the appointment.

cancellation_reasonstring

Optional free text description for the appointment cancellation. Only use this field when cancellation_reason_type is set to 'other_patient_reason' or 'other_provider_reason'.

cancellation_reason_type'patient_no_longer_needs_appointment' | 'patient_no_longer_available' | 'other_patient_reason' | 'missing_needed_patient_information' | 'payment_or_insurance_issue' | 'patient_or_visit_type_not_accepted' | 'provider_not_available' | 'rescheduling_patient' | 'other_provider_reason'

Enum field describing why the appointment was cancelled. This field is optional but recommended when known for metrics purposes. If the cancellation reason does not match any predefined enum values, use 'other_patient_reason' or 'other_provider_reason' and provide a free text explanation in the cancellation_reason field.

Example request

{
  "appointment_id": "d04b049a-41b1-4aba-9268-d8973cf72cdd"
}

Response

Successful

request_idstring required

Unique request identifier for tracing

Changes

No recorded changes to this operation across all 1 revision of this API.