Skip to content
API Docs/
API Reference
/
/
Cancel an Appointment

Cancel an Appointment

Request

Cancels a confirmed appointment. Returns immediately with status "cancelling"; the cancellation is confirmed asynchronously. Poll Get Appointment Status for the outcome.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
suppress_mailboolean
suppress_cancellation_policyboolean
episode_idstring^\d+$
curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/appointments/{id}/cancel' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "suppress_mail": true,
    "suppress_cancellation_policy": true,
    "episode_id": "string"
  }'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
statusstringrequired
Enum:"reserved""pending""confirmed""cancelling""rescheduling""abandoned""cancelled""failed""unknown"
Response
{
  "id": "string",
  "status": "reserved"
}