Cancel a report addendum

client.autoScribe.reports.cancelAddendum(, ?): ReportCancelAddendumResponse { success, message }

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

reportID: string

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

ReturnsExpand Collapse

ReportCancelAddendumResponse { success, message }

Response for cancelling a report addendum

success: boolean

message?: string

Cancel a report addendum

import Avara from 'avara';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

const response = await client.autoScribe.reports.cancelAddendum(
  'rep_1234567890abcdef1234567890abcdef',
);

console.log(response.success);

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

Returns Examples

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