ZOzocdoc
appointments

Create appointment

This endpoint is used for creating new appointments. Developers should gather the necessary information to pass in the request body as inputs for this endpoint. Only timeslots retrieved from the /v1/provider_locations/availability endpoint will be accepted. After an /appointments call is successfully processed, the system will return an appointment ID.

The appointment_id returned is used in the endpoint /v1/appointments/{appointment_id} to track the status of the appointment, and in the endpoint /v1/appointments/cancel to cancel an appointment.

post/v1/appointments

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_type'providers' required

The type of appointment.

Example request

{
  "data": {
    "start_time": "2022-04-27T09:00:00-04:00",
    "visit_reason_id": "pc_FRO-18leckytNKtruw5dLR",
    "provider_location_id": "pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890",
    "patient": {
      "phone_number": "9999999999",
      "email_address": "test@example.com",
      "patient_address": {
        "state": "NY"
      },
      "insurance": {
        "insurance_plan_id": "ip_31820"
      }
    },
    "patient_type": "new"
  }
}

Response

Successful

request_idstring required

Unique request identifier for tracing

Example response

{
  "data": {
    "location_phone_number": "9999999999"
  }
}

Changes

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