Probatix Diagnostics API v1Diagnostic Tests
Cancel a diagnostic test
Cancels an eligible DiagnosticTest.
Cancels an eligible DiagnosticTest.
Authorization
apiKey X-API-TOKEN<token>
In: header
Path Parameters
id*string (uuid)
DiagnosticTestCancelInput identifier
Header Parameters
accept-language?string
Language for Errors and Translatable properties
Allowed values: "de", "en", "fr"
The new DiagnosticTestCancelInput resource
TypeScript Definitions
Use the request body type in TypeScript.
body*DiagnosticTestCancelInput
cancellationReason?string | null
Optional reason for cancelling the diagnostic test.
cancellationReasonComment?string | null
Optional additional detail about the cancellation.
Response Body
curl -X POST "https://example.com/v1/diagnostic_tests/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \ -H "accept-language: de" \ -H "Content-Type: application/json" \ -d '{ "cancellationReason": "patient_request", "cancellationReasonComment": "Requested before evaluation." }'Empty