Bulk edit documents
paperless_bulk_edit_documentsApply one operation to multiple documents in a single request—tag, modify metadata, reprocess, or delete—by supplying document IDs and the chosen action.
Instructions
Apply one operation to many documents at once. Supply only the parameters the chosen method needs. Runs asynchronously on the server. delete moves documents to the trash and requires confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method | Yes | Operation to perform. | |
| tag_id | No | For `add_tag` / `remove_tag`. | |
| confirm | No | Required for `delete`. | |
| add_tag_ids | No | For `modify_tags`. | |
| document_ids | Yes | Documents to act on. | |
| remove_tag_ids | No | For `modify_tags`. | |
| storage_path_id | No | For `set_storage_path`. | |
| correspondent_id | No | For `set_correspondent`. | |
| document_type_id | No | For `set_document_type`. | |
| add_custom_fields | No | For `modify_custom_fields`: map of custom field id to value. | |
| remove_custom_field_ids | No | For `modify_custom_fields`: custom field ids to strip. |