Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

appointmentId
string
required

The appointment id.

Minimum string length: 1

Query Parameters

locationId
string
required

The sub-account this calendar belongs to. It is the only thing that identifies the tenant here, and access is re-checked against it on every call.

Body

application/json

Why, for the record.

reason
string
Example:

"Patient called to cancel."

{key}
any

Response

Cancelled.

success
boolean
required
data
object
required

The appointment as it now stands.

{key}
any