Update appointment

put

https://api.heim.health/v1/appointments/{appointmentId}

Update appointment by appointment id

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

appointmentId

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

externalRef

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.

note

string | null

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

phoneNumber

string

length between 7 and 16

The mobile/cell phone number of the main contact for this Appointment. This number should support SMS messages in order to receive important notifications. Must be a fully qualified number starting with + and the country code, such as +44 or +1 with no spaces in the number.

Responses

200

Appointment updated

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad request

401Unauthorised

404Not found