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

Document

Partial update document

Changed on Sep 1, 2026

Update part of a document object.

patch/api/v1/documents/{documentID}

Request

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

Path parameters

documentIDinteger required

Document ID

Request body

idinteger

ID of the document

urlstring url

URL of the document

s3_namestring

Storage key of the document file. Internal use only.

parentstring url nullable

URL of the parent document (e.g. the zip file it was extracted from)

emailstring uri nullable

URL of the email object that document was imported by (only for document imported by email).

annotationsstring[]

List of annotations related to the document. Usually there is only one annotation.

mime_typestring

MIME type of the document (e.g. application/pdf)

creatorstring url nullable

User that created the annotation.

created_atstring date-time

Timestamp of document upload or incoming email attachment extraction.

arrived_atstring date-time

See created_at

original_file_namestring

File name of the attachment or upload.

contentstring url

Link to the document's raw content (e.g. PDF file). May be null if there is no file associated.

Reason why the Document got filtered out on Email ingestion.

metadataMetadata

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Example request

{
  "id": 314628,
  "url": "https://example.rossum.app/api/v1/documents/314628",
  "s3_name": "272c2f01ae84a4e19a421cb432e490bb",
  "parent": "https://example.rossum.app/api/v1/documents/203517",
  "email": "https://example.rossum.app/api/v1/emails/1234",
  "annotations": [
    "https://example.rossum.app/api/v1/annotations/314528"
  ],
  "mime_type": "application/pdf",
  "creator": "https://example.rossum.app/api/v1/users/1",
  "created_at": "2020-05-21T12:34:56.789Z",
  "arrived_at": "2020-05-21T12:34:56.789Z",
  "original_file_name": "invoice.pdf",
  "content": "https://example.rossum.app/api/v1/documents/314628/content",
  "attachment_status": "processed",
  "metadata": {
    "some_key": "some_value"
  }
}

Response