bulk_edit_documents
Simplify document management by enabling batch operations such as tagging, archiving, reprocessing, and metadata updates for multiple files in Paperless-NGX.
Instructions
Perform bulk operations on documents
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| add_tags | No | ||
| correspondent | No | ||
| degrees | No | ||
| delete_originals | No | ||
| document_type | No | ||
| documents | Yes | ||
| metadata_document_id | No | ||
| method | Yes | ||
| pages | No | ||
| permissions | No | ||
| remove_tags | No | ||
| storage_path | No | ||
| tag | No |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"add_tags": {
"items": {
"type": "number"
},
"type": "array"
},
"correspondent": {
"type": "number"
},
"degrees": {
"type": "number"
},
"delete_originals": {
"type": "boolean"
},
"document_type": {
"type": "number"
},
"documents": {
"items": {
"type": "number"
},
"type": "array"
},
"metadata_document_id": {
"type": "number"
},
"method": {
"enum": [
"set_correspondent",
"set_document_type",
"set_storage_path",
"add_tag",
"remove_tag",
"modify_tags",
"delete",
"reprocess",
"set_permissions",
"merge",
"split",
"rotate",
"delete_pages"
],
"type": "string"
},
"pages": {
"type": "string"
},
"permissions": {
"additionalProperties": false,
"properties": {
"merge": {
"type": "boolean"
},
"owner": {
"type": [
"number",
"null"
]
},
"set_permissions": {
"additionalProperties": false,
"properties": {
"change": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"type": "number"
},
"type": "array"
},
"users": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"users",
"groups"
],
"type": "object"
},
"view": {
"additionalProperties": false,
"properties": {
"groups": {
"items": {
"type": "number"
},
"type": "array"
},
"users": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"users",
"groups"
],
"type": "object"
}
},
"required": [
"view",
"change"
],
"type": "object"
}
},
"type": "object"
},
"remove_tags": {
"items": {
"type": "number"
},
"type": "array"
},
"storage_path": {
"type": "number"
},
"tag": {
"type": "number"
}
},
"required": [
"documents",
"method"
],
"type": "object"
}