Cancel a consultation
POST/telehealth/consultations/:id/cancel
Cancels a partner-origin questionnaire consultation while pending or in review, provided no prescription exists. Shop, patient-request, doctor-directed, pharmacy, cart, appointment/hold, and video-meeting flows are not supported; a linked provider patient is required. Repeating a supported cancellation succeeds without changing cancelledAt; historical cancellations may have a null timestamp. Rejected, awaiting-signature, completed, unsupported, or prescription-bearing consultations return OperationNotPermitted (403), as does a consultation that can no longer be updated in an eligible state. Unknown consultations and consultations belonging to another organization return NotFound (404). Invalid input returns InvalidArguments (400). Missing/unknown API keys return Unauthorized (401), inactive providers return TelemedicineProviderNotActive (403), and unexpected failures return InternalError (500). Cancellation releases counted monthly allowance while retaining clinical history and identity. This operation does not issue a refund, send a webhook, or alter the prescription signing lifecycle.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Successful response
The request input failed validation. payload.issues lists the offending paths when the failure is schema-level; otherwise payload.message carries the reason.
Missing or invalid API key.
TelemedicineProviderNotActive: The provider exists but is not active.
OperationNotPermitted: The authenticated account cannot perform this operation in the current context.
The addressed resource does not exist.
An unexpected error occurred. payload.id is a correlation id for support.