Paperless-ngx icon

Paperless-ngx

Consume documents and metadata from Paperless-ngx API

Document → Update a Document

AI-generated

Summary

Update a Paperless-ngx document’s metadata by selecting it from a list or providing its ID or document URL, then setting fields in Update Fields. Fields you leave unset are not included in the update; Paperless may add additional fields automatically.

Inputs

  • ID (required) — Choose a document from the list, enter a positive integer ID, or provide a Paperless document URL ending in /documents/{id}/details.
  • Update Fields — Optionally set title, searchable content, archive serial number, creation date, correspondent, document type, or storage path. Add tags with Tags or Tags JSON; Tags JSON overrides Tags when set. Set Append Tags to preserve existing tags while adding the supplied tags; otherwise supplied tags replace them. Use Remove Tags JSON to remove specified tag IDs while preserving the other existing tags. Add custom fields with Custom Fields or Custom Fields JSON; the JSON form overrides the collection when set.

Output shape

A single updated document record.

The operation updates the selected document in Paperless-ngx and returns the API response. The source pack provides only a signature-level view of this operation, so the response shape and handling of empty field values are not visible.

Links

Discussion