Cancel a study

POST/v1/autoScribe/studies/cancel

Marks a study as cancelled. Cancelled studies are preserved but flagged as inactive. Can be identified by either study ID or DICOM Study Instance UID.

Body ParametersJSONExpand Collapse

studyId: optional string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: optional string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

ReturnsExpand Collapse

success: boolean

message: optional string

Cancel a study

curl https://api.avarasoftware.com/v1/autoScribe/studies/cancel \
    -X POST \
    -H "Authorization: Bearer $AVARA_API_KEY"

{
  "success": true,
  "message": "message"
}

Returns Examples

{
  "success": true,
  "message": "message"
}