HomeGuidesAPI Reference
Log In
API Reference

Cancel appointment

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

Cancel an appointment

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

To cancel an appointment

string | null
required

A note detailing the reason for the cancellation in text form.

string
enum
required

The restricted set of entities allowed to cancel via the public API. This value helps to track who requested the cancellation for accountability

Allowed:
string
enum
required

The entity believed to be responsible for the cancellation. This value affects whether charges may apply for the cancellation. Select 'platform' if the cancellation is due to a Heim issue.

Allowed:
string
enum
required

The restricted list of possible reasons for this cancellation. This value affects whether charges may apply for the cancellation

Responses

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?