Annotation

Cancel edit pages session

Cancels an edit pages session, stopping review on specified child annotations and optionally the parent.

post/api/v1/annotations/{annotationID}/edit_pages/cancel

Path parameters

annotationIDinteger required

Annotation ID

Request body

annotationsstring[]

Child annotations to cancel (stop reviewing). Must be in the reviewing state.

cancel_parentboolean

Whether to also cancel the parent annotation

Example request

{
  "annotations": [
    "https://example.rossum.app/api/v1/annotations/67890"
  ],
  "cancel_parent": true
}

Response

Edit pages session cancelled successfully

Changes

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