Annotation31

Annotation Content9

Audit Log1

Automation Blocker2

Configuration Changelog1

Connector6

Dedicated Engine7

Dedicated Engine Schema8

Delete Recommendation6

Document7

Document Relation6

Documents Download3

Email7

Email Template7

Email Thread4

Engine9

Engine Field7

Generic Engine2

Generic Engine Schema2

Hook12

Hook Run3

Hook Template2

Inbox6

Integration Credential2

Label7

Membership6

Organization11

Organization Group14

Page2

Queue15

Relation6

Rule6

Rules Execution Log1

Saved View6

Schema8

Suggested Edit6

Task1

Trigger6

Upload3

User13

User Role2

Workflow2

Workflow Activity2

Workflow Run3

Workflow Step2

Workspace6

Annotation Content

Update annotation content

Changed on Sep 1, 2026

Update annotation content. The format is the same as for GET. Datapoints missing from the payload keep their previous values.

For multivalue (table) datapoints, rows in the payload are matched to existing rows by position: extra rows in the payload are appended, and existing rows beyond the end of the payload are removed. Within a row:

For an existing row, columns missing from the payload keep their previous values.
For a newly appended row, columns missing from the payload are filled from the schema's default_value (and remain empty if the schema declares no default).

patch/api/v1/annotations/{annotationID}/content

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/annotations/:annotationID/content/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

annotationIDinteger required

Annotation ID

Request body

Example request

{
  "content": [
    {
      "id": 197466,
      "url": "https://example.rossum.app/api/v1/annotations/319668/content/197466",
      "schema_id": "invoice_info_section",
      "children": [
        {
          "id": 27801933,
          "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
          "schema_id": "some_id",
          "children": [
            {
              "id": 27801933,
              "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
              "schema_id": "some_id",
              "children": [
                {
                  "id": 27801933,
                  "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
                  "schema_id": "some_id",
                  "content": {
                    "value": "8/12/24",
                    "normalized_value": "12-08-2024",
                    "page": 1,
                    "position": [
                      202.3,
                      100.1,
                      110.442,
                      110
                    ],
                    "rir_text": "8/12/24",
                    "rir_raw_text": "8/I2/24",
                    "rir_page": 1,
                    "rir_position": [
                      202.3,
                      100.1,
                      110.442,
                      110
                    ],
                    "rir_confidence": 0.954233451,
                    "connector_text": "8/I2/24",
                    "connector_position": [
                      200,
                      100,
                      110,
                      110
                    ],
                    "ocr_text": null,
                    "ocr_raw_text": null,
                    "ocr_position": null
                  },
                  "validation_sources": [
                    "score"
                  ]
                }
              ]
            }
          ],
          "grid": {
            "parts": [
              {
                "page": 1,
                "columns": [
                  {
                    "left_position": 12.1,
                    "schema_id": "item_description",
                    "header_texts": [
                      "Item description"
                    ]
                  }
                ],
                "rows": [
                  {
                    "top_position": 112.29,
                    "tuple_id": 1,
                    "type": "data"
                  }
                ],
                "width": 123.2,
                "height": 513.2
              }
            ]
          }
        }
      ]
    }
  ]
}

Response

Example response

{
  "content": [
    {
      "id": 197466,
      "url": "https://example.rossum.app/api/v1/annotations/319668/content/197466",
      "schema_id": "invoice_info_section",
      "children": [
        {
          "id": 27801933,
          "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
          "schema_id": "some_id",
          "children": [
            {
              "id": 27801933,
              "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
              "schema_id": "some_id",
              "children": [
                {
                  "id": 27801933,
                  "url": "https://example.rossum.app/api/v1/annotations/319668/content/27801933",
                  "schema_id": "some_id",
                  "content": {
                    "value": "8/12/24",
                    "normalized_value": "12-08-2024",
                    "page": 1,
                    "position": [
                      202.3,
                      100.1,
                      110.442,
                      110
                    ],
                    "rir_text": "8/12/24",
                    "rir_raw_text": "8/I2/24",
                    "rir_page": 1,
                    "rir_position": [
                      202.3,
                      100.1,
                      110.442,
                      110
                    ],
                    "rir_confidence": 0.954233451,
                    "connector_text": "8/I2/24",
                    "connector_position": [
                      200,
                      100,
                      110,
                      110
                    ],
                    "ocr_text": null,
                    "ocr_raw_text": null,
                    "ocr_position": null
                  },
                  "validation_sources": [
                    "score"
                  ]
                }
              ]
            }
          ],
          "grid": {
            "parts": [
              {
                "page": 1,
                "columns": [
                  {
                    "left_position": 12.1,
                    "schema_id": "item_description",
                    "header_texts": [
                      "Item description"
                    ]
                  }
                ],
                "rows": [
                  {
                    "top_position": 112.29,
                    "tuple_id": 1,
                    "type": "data"
                  }
                ],
                "width": 123.2,
                "height": 513.2
              }
            ]
          }
        }
      ]
    }
  ]
}

Changes

Sep 1, 2026f1b5a910991d Revision changes
- breaking
  added subschema #2 to the / request property allOf list
- breaking
  the / request property type changed from object to no type
- breaking
  the / response's property type changed from object to no type for status
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- info
  added subschema #2 to the / response property allOf list for the response status

Operation history