Create appointment (beta)

🚧

Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Removes query param notify_patient; adds request fields appt.patient.bio.address_line_1, appt.patient.bio.address_line_2, appt.patient.bio.cell_phone_number, appt.patient.bio.city (+6 more); and other schema changes.

This endpoint books an appointment for the given patient with the given provider at the specified location. When is_guardian is true, the booking is made by a guardian and a patient object with the dependent's details must be provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Used to scope the request to the specified institution

int32
required

Used to scope the request to the specified location

Body Params

Create appointment

int32
1 to 5
Defaults to 1
appt
object
required

Appointment detail object

Headers
string
required
Defaults to v3.1.0

The NexHealth API version

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
ChangelogMCP serverErrorsdevelopers@nexhealth.com