Cancellation cannot be undone
When an appointment is cancelled, the host and all participants will receive emails to inform them of the change. It is not possible to undo a cancellation.
Cancellation is considered an "update" operation
To cancel an appointment, you will need to use the PATCH method above and update the "cancelled" field to be "true". See the example below.
Example request
curl --request PATCH 'https://api.oncallhealth.ca/appointments/1234/' \
--header 'Authorization: Token YOUR_PROVIDER_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"cancelled": true
}'
Example response
{
"url": "https://api.oncallhealth.ca/appointments/1234/",
"title": "Sample API appointment",
"datetime": "2026-01-15T00:00:00Z",
"duration": 60,
"type": "inperson",
"status": "Incomplete",
"cancelled": true,
"division": "https://api.oncallhealth.ca/divisions/123/",
"participants": [
{
"url": "https://api.oncallhealth.ca/participants/123/",
"answers": "https://api.oncallhealth.ca/appointmentfieldanswers/?participant_id=123",
"appointment": "https://api.oncallhealth.ca/appointments/1234/",
"name": "Existing Participant",
"first_name": "Existing",
"last_name": "Participant",
"email": "[email protected]",
"fee": 10.0,
"cancelled": false
},
{
"url": "https://api.oncallhealth.ca/participants/456/",
"answers": "https://api.oncallhealth.ca/appointmentfieldanswers/?participant_id=456",
"appointment": "https://api.oncallhealth.ca/appointments/1234/",
"name": "New participant",
"first_name": "New",
"last_name": "Participant",
"email": "[email protected]",
"fee": 10.0,
"cancelled": false,
"user_id": 2
}
],
"answers": "https://api.oncallhealth.ca/appointmentfieldanswers/?appointment_id=1234",
"metadata": null
}