Cancelling appointments

For requests or help with our API
Post Reply
jarkkok
Posts: 16
Joined: Mon Jul 26, 2021 7:46 am

Cancelling appointments

Post by jarkkok » Thu Aug 05, 2021 8:06 am

I'm able to confirm appointments using PUT, for example: https://api.opendental.com/api/v1/appoi ... 63/Confirm with body {"confirmVal":"Confirm"}. Querying appointment status show the status as Confirmed. I can use some other statuses in confirmVal as well.

What would be the way to cancel an appointment through the API? I haven't found a suitable confirmVal for that.

SLeon
Posts: 24
Joined: Mon Mar 01, 2021 11:00 am

Re: Cancelling appointments

Post by SLeon » Thu Aug 05, 2021 8:44 am

The Confirmed field is tied to the eServices Automated Messaging feature, if the office has set that up. More information can be found here https://opendental.com/manual/confirmationstatus.html.

Currently the API does not support cancelling an appointment, only rescheduling, but we can look into this.

SLeon
Posts: 24
Joined: Mon Mar 01, 2021 11:00 am

Re: Cancelling appointments

Post by SLeon » Wed Sep 01, 2021 1:42 pm

The method Appointments PUT Confirm has been recently expanded to support all appointment confirmation statuses. This will allow you to set the status to "Broken" to indicate a cancellation, or to any other ApptConfirm status the office has setup, via a defNum.

The original confirmVal field is used by offices with eServices Automated Messaging set up and want to use those statuses instead. More information on this method can be found on our updated documentation https://www.opendental.com/resources/OpenDentalAPI.pdf.

Post Reply