Appointment Notes

The Appointment Note feature allows the users to document free-form text associated with the appointment. This functionality provides the user to create, modify, retrieve or delete notes.

Once an appointment is booked, you can cancel or reschedule it using one of the following calls:

  • /appointments/{appointmentid}/cancel
  • /appointments/{appointmentid}/reschedule

If you cancel an appointment, the appointment notes associated with the cancelled appointment no longer show via the API unless you turn on the SHOWDELETED flag. If you schedule a new appointment that replaces the cancelled one (i.e., cancel and reschedule), the appointment notes move over to the new appointment.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Create appointment note
POST
/v1/{practiceid}/appointments/{appointmentid}/notes

Creates a note for a specific appointment

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
Example Code
Get all appointment notes
Update appointment note
PUT
/v1/{practiceid}/appointments/{appointmentid}/notes/{noteid}

Modifies the note details for a specific appointment

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
Example Code
Delete appointment note
DELETE
/v1/{practiceid}/appointments/{appointmentid}/notes/{noteid}

Deletes a note for a specific appointment

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
Example Code