Create Appointment

POST

Create a client appointment

Headers

X-Account-TokenstringOptional

Account Token

Request

This endpoint expects an object.
patientIdintegerRequired
patientNamestringRequired
patientPhonestringRequired
patientEmailstringRequired
clinicIdintegerRequired
doubleBookingbooleanRequired
patientToBeChargedintegerRequired

How much to charge the patient in dollars right now. Usually 0 for no charge at the time of booking.

datedateRequired
timestringRequired

The time of the appointment in 24 hour format (“15:15:00”)

notesstringRequired

Notes to attach to the appointment booking.

typeOfAppointment"in_person" or "virtual"Required
Allowed values: in_personvirtual
outsideScheduledHoursbooleanRequired
appointmentServicelist of objectsRequired

The services that you want to book. You can get a list of available services from the getAppointmentTypes endpoint.

durationintegerRequired

The duration of the appointment in minutes. You can find the duration of each service from the getAppointmentTypes endpoint.

providerIdintegerRequired
clearentEmailIdstringRequired

The email address associated with the person paying. Usually the same as the person who is making the booking.

clearentZipstringRequired

The zip code of the person who is paying for the booking. Usually the same as the person who is making the booking.

paymentInfoobjectRequired

Response

This endpoint returns an object.
status"ok" or "error"
Allowed values: okerror