ZOzocdoc
appointments

Update appointment status

Use this endpoint to update the status of an appointment to either 'arrived' or 'no_show'.

  • arrived: Indicates the patient has arrived at the office.
  • no_show: Indicates the patient did not show up for their scheduled appointment. Appointment start time should be in the past but no older than 2 days to be marked as no_show.
put/v1/appointments/update-status

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.

appointment_status'arrived' | 'no_show' required

New status to set for the appointment. Accepted values:

  • arrived: Patient has arrived at the office.
  • no_show: Patient did not show up for their appointment.

Example request

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

Response

Successful status update

request_idstring required

Unique request identifier for tracing

Changes

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