This is a POST
request to the following API endpoint:
https://questions.morf.health/api/scheduleAppointment
The request body must contain the following parameters:
morfOrgId
: (string) The organization ID.appointmentTypeId
: (string) The appointment type ID.datetime
: (string) The scheduled date and time of the appointment (in ISO 8601 format).timezone
: (string) The timezone in IANA
format (e.g., “America/New_York”).providerId
: (string) The provider’s ID.schedulingApplication
: (string) The application used for scheduling, HEALTHIE
or ACUITY
.firstName
: (string) The patient’s first name.lastName
: (string) The patient’s last name.phoneNumber
: (string) The patient’s phone number.emailAddress
: (string) The patient’s email address.patientId
: (string) The patient’s ID.sendWelcomeEmail
: (optional, boolean) Whether to send a welcome email. Default is false
.uniqueByEmail
: (optional, boolean) Whether the appointment is unique by email. Default is true
.contactType
: (optional, string) The type of contact. Options: Healthie Video Chat
, Secure Videochat
, In Person
, or Phone Call
. Default is Video Call
.Here’s an example of what the request body could look like:
When the booking is successful, the response will be:
When the booking is not successful, the response could be one of the following: