Skip to main content
Cancel a single appointment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required
Required range: x > 0
Example:

1

Body

application/json
reasonId
integer
required

The cancellation reason id

Required range: x > 0
Example:

1

note
string

An optional note for the cancellation

Example:

"Patient called to cancel"

Response

200 - text

Return 1 on success

The response is of type enum<number>.

Available options:
1