Annotation

Reject annotation

Reject annotation, switch its status to rejected.

<Callout type="info"> Rejection is allowed only for documents in states: `to_review`, `reviewing`, `postponed`, `in_workflow`, `exported`. See [Document Lifecycle](/guides/annotation-lifecycle) for more information about states. </Callout>

If rejecting in in_workflow state, the annotation.workflow_run.workflow_status will also be set to rejected and a workflow activity record object will be created. Only admin, organization group admin, or an assigned user can approve annotation in this state.

<Callout type="info"> Talk with a Rossum representative about enabling this feature. Read more about workflows [here](/guides/workflow-guide) </Callout>
post/api/v1/annotations/{annotationID}/reject

Request body

note_contentstring

Rejection note.

automatically_rejectedboolean

Designates whether annotation is displayed as automatically rejected in the statistics.

Response

OK

statusstring

New status of the annotation (rejected).

notestring uri

Link to Note object.

Example response

{
  "status": "rejected",
  "note": "https://example.rossum.app/api/v1/notes/3"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.