Skip to main content
POST
Cancel an appointment

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

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