Cancel a report addendum

auto_scribe.reports.cancel_addendum() -> ReportCancelAddendumResponse

post/v1/autoScribe/reports/{reportId}/cancel-addendum

Cancels an in-progress addendum and reverts the study status to 'completed'. The original report remains unchanged. Only valid for active addendums.

ParametersExpand Collapse

report_id: str

Unique report identifier. Format: rep_{32-hex-chars}

ReturnsExpand Collapse

class ReportCancelAddendumResponse: …

Response for cancelling a report addendum

success: bool

message: Optional[str]

Cancel a report addendum

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.auto_scribe.reports.cancel_addendum(
    "rep_1234567890abcdef1234567890abcdef",
)
print(response.success)

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

Returns Examples

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