Skip to main content
POST
Cancel an appointment

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

x-session-token
string

The App Bridge token of the logged-in user (maxcare.appToken()), verified for this app and organization. With it the change is made through that user's own EHR login when they have a usable one; without it, through the organization's system login (meta.resolvedBy says which). A token that does not verify is 401 authorizer_unverified. Sent as a header so it stays out of URLs.

X-Organization-Id
string
required

Target clinic organization ID

Path Parameters

id
string
required

Appointment ID

Body

application/json
reasonId
string

Cancellation reason externalId from GET /appointments/cancel-reasons. Ignored on EHRs with no reason catalogue.

note
string

Free-text cancellation note, where the EHR stores one

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required