## Cancel

`viewer.studies.cancel(StudyCancelParams**kwargs)  -> StudyCancelResponse`

**post** `/v1/viewer/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.

### Parameters

- `study_id: Optional[str]`

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

- `study_instance_uid: Optional[str]`

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

### Returns

- `class StudyCancelResponse: …`

  Response for cancelling a study in Viewer

  - `success: bool`

  - `message: Optional[str]`

### Example

```python
import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
response = client.viewer.studies.cancel()
print(response.success)
```