bulk_edit_documents
Apply bulk changes to multiple Paperless-NGX documents at once: update tags, correspondents, types, custom fields, permissions, or process actions like merge, split, rotate, and delete.
Instructions
Perform bulk operations on multiple documents. Note: 'remove_tag' removes a tag from specific documents (tag remains in system), while 'delete_tag' permanently deletes a tag from the entire system. ⚠️ WARNING: 'delete' method permanently deletes documents and requires confirmation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | ||
| merge | No | For set_permissions: true adds to existing permissions and keeps the current owner; false (default) replaces the listed users/groups | |
| owner | No | For set_permissions: new owner user ID, or null to remove the owner. Unless merge is true, omitting owner also clears the current owner. | |
| pages | No | ||
| method | Yes | ||
| confirm | No | Must be true when method is 'delete' to confirm destructive operation | |
| degrees | No | ||
| add_tags | No | ||
| documents | Yes | ||
| remove_tags | No | ||
| storage_path | No | ||
| correspondent | No | ||
| document_type | No | ||
| set_permissions | No | For set_permissions: view/change permissions to apply. Omitted actions (view/change) and omitted users/groups lists are left untouched; an empty list [] removes all (unless merge is true). Omit entirely for owner-only changes. | |
| delete_originals | No | ||
| add_custom_fields | No | ||
| metadata_document_id | No | ||
| remove_custom_fields | No |