HomeGuidesAPI Reference
Log In
API Reference

Create appointment

post
https://api.heim.health/v1/appointments

Create an appointment

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

To create an appointment

string
required

The id of the patient. The format is a string starting with p_

string
required

The Id of the task. The format is a string starting with tsk_

string | null

The windowId starting with win_ that is obtained from the Availability API. If this is omitted, then patient-led scheduling will be initiated https://docs.heim.health/docs/scheduling-appointments#scheduling-modes where the Patient will choose a window

string | null

An optional external reference you provide from your system. You may filter list responses with this reference to easily find a resource on the Heim platform. Uniqueness is not enforced.

string | null

A note visible to the Practitioner who carries out the task.

string
required
length between 7 and 16

Phone number in the E.164 format. See https://www.twilio.com/docs/glossary/what-e164

location
object
required

address object

documentIds
array of strings

The optional document ids to attach to the appointment that have already been uploaded. This feature may not be available to your organisation.

documentIds
date | null

Only available for appointments of type "scheduled" https://docs.heim.health/docs/scheduling-appointments#appointment-types. This date is used to set the earliest date that the Appointment should happen.

date | null

Only available for appointments of type "scheduled" https://docs.heim.health/docs/scheduling-appointments#appointment-types. This date is used to set the latest date that the Appointment should happen. Please note that there may be a constraint in place to enforce a minimum number of days between planFrom and planTo dates.

metadata
object | null

A property used to pass additional information for use during the Appointment lifecycle. Please see this guide to using metadata https://docs.heim.health/docs/metadata

Responses

Updated 12 months ago

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

Updated 12 months ago