edit_documents_bulk
Apply one operation (retag, reassign, delete, reprocess) to many selected Paperless documents at once. Pick documents by IDs or filters and update them in a single bulk action.
Instructions
Apply ONE of a fixed set of operations to MANY documents at once. Methods: set_correspondent, set_document_type, set_storage_path, add_tag, remove_tag, modify_tags, modify_custom_fields, set_permissions, delete, reprocess, merge, split, rotate, delete_pages, edit_pdf, remove_password. For per-document field edits including title, content, created (date), archive_serial_number, or owner, use update_document instead — those fields are not editable here. Note: 'remove_tag' only removes the tag from the specified documents (tag stays in the system); 'delete_tag' permanently deletes the tag from the entire system. ⚠️ WARNING: method 'delete' permanently deletes documents and requires confirm=true. Select documents either by documents (IDs) or by all: true + filters — Paperless document filter names such as correspondent__id, tags__id__all, document_type__id, title_content, created__date__gte or query (full text); the filter form changes every matching document in one call, e.g. reassigning all documents from a duplicate correspondent before deleting it. Unknown filter keys are refused, and the result reports matched_documents. all=true is not supported for merge, split, delete_pages, edit_pdf or remove_password. Method remove_password strips a PDF password (needs password); with update_document=true the unlocked file is stored as a new version of the same document. Method reprocess accepts remote_ocr=true to use the configured remote OCR engine.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all | No | Select every document matching `filters` instead of listing IDs | |
| tag | No | ||
| merge | No | When true with set_permissions, merges with existing permissions instead of replacing. | |
| owner | No | Owner user ID for set_permissions method (null clears the owner). | |
| pages | No | ||
| method | Yes | ||
| confirm | No | Must be true when method is 'delete' to confirm destructive operation | |
| degrees | No | ||
| filters | No | With all=true (required then): Paperless document filters, e.g. {"correspondent__id": 12}, {"tags__id__all": "3,4"}, {"document_type__id": 5}, {"title_content": "invoice"}. Not list_documents' tool arguments: use correspondent__id, not correspondent. Unknown keys are refused. | |
| add_tags | No | ||
| password | No | remove_password: the PDF's password | |
| documents | No | Document IDs to change. Omit when selecting with all + filters. | |
| operations | No | Per-page operations for edit_pdf method. Each entry: {page, rotate?, doc?}. | |
| remote_ocr | No | reprocess: OCR with the remote OCR engine configured in Paperless instead of the local one (default false) | |
| remove_tags | No | ||
| storage_path | No | ||
| correspondent | No | ||
| document_type | No | ||
| delete_original | No | remove_password / edit_pdf: delete the original after writing a separate new document (ignored with update_document=true) | |
| set_permissions | No | Permission grants for set_permissions method. view/change each take user and group ID lists. | |
| update_document | No | edit_pdf / remove_password: store the result as a new version of the same document instead of creating a new document (default false). | |
| delete_originals | No | ||
| include_metadata | No | edit_pdf / remove_password: copy metadata to the new document (default true). | |
| add_custom_fields | No | ||
| excluded_documents | No | With all=true: IDs to leave out of the selection | |
| metadata_document_id | No | ||
| remove_custom_fields | No |