HomeGuidesAPI Reference
Log In
API Reference

Update appointment

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

Update appointment by appointment id

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

Pass the appointment Id. The format is a string starting with apt_

Body Params

A restricted update to an existing appointment. For updating status to "cancelled," note, externalRef or the Appointment phoneNumber

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
length between 7 and 16

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

Responses
200

Appointment updated

Updated about 1 year ago

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

Updated about 1 year ago

Did this page help you?