Reschedule appointment

post

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

Allows an organisation to reschedule an appointment. Performs an availability check and immediately updates the appointment with the new window and shift. Rescheduling is not possible once the appointment's reschedule deadline has passed; the request is rejected with a 400. A 400 is also returned if the appointment is not scheduled, the window does not exist, or the window is no longer available. The patient is notified of the new time, and webhooks receive an appointment.scheduled event.

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

windowId

string

required

The id of the new window, starting with win_, obtained from the Availability API.

causingEntity

string

enum

required

The entity responsible for the reschedule

Allowed:

note

string

length ≤ 500

A note explaining the reschedule. Helps Heim understand why reschedules occur. Required for faulty_equipment, organisation_rescheduled and patient_rescheduled.

reasonCode

string

enum

required

Reason for the reschedule. Must be valid for the given causingEntity (patient or organisation codes respectively). Use invalid_location_address when the original address was wrong.

Allowed:

location

object

A new address for the appointment. Omit it to keep the current address. When provided, availability for the chosen windowId is validated against this postcode, not the appointment's current one.

Responses

200

Successfully rescheduled appointment

400Bad request

401Unauthorised

403Forbidden

404Not found