Skip to content

DearDoc Appointments Manager Integration

This document provides all the necessary information for third-party integrators to connect with the Appointment Manager API. The API allows you to programmatically create and update appointments in our system.

All data is exchanged in JSON format. The API is built around a single primary endpoint for managing appointments, where the action to be performed (create or update) is specified within the request body.

Authentication

Authentication details, including the host and your practiceId, will be provided to you separately.

Appointment Management

The API uses a single, powerful endpoint to manage the lifecycle of an appointment. All actions—creating, updating, and deleting—are performed by sending a POST request to this endpoint. The specific action is determined by the action field within the JSON payload.

Updates to existing appointments are matched using a combination of the practiceId and the appointment.origin_id you provide. All synchronizations happen in near-real-time.

Action 1: Creating an Appointment

To create a new appointment, set the action field to create and provide the complete appointment, patient, and calendar objects.

Action 2: Updating an Appointment's Status

To update an existing appointment, set the action field to update. You must provide the appointment.origin_id to identify the appointment, along with the appointment.status field containing the new status.

The most common statuses are:

  • confirmed: The appointment is scheduled and confirmed by the patient.
  • cancelled: The appointment has been cancelled and will not occur.
  • showed: The patient attended the appointment.
  • noshow: The patient did not attend the appointment.

Action 3: Deleting an Appointment

To delete an appointment, you perform an update. Set the action field to update and change the appointment.status to deleted. This marks the appointment for removal in our system.