Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
The node provides integration with the Paperless NGX API, specifically allowing partial updates to tags within the system. This operation is useful when you want to modify certain attributes of an existing tag without replacing the entire tag object. For example, you might update the color or matching algorithm of a tag to better categorize documents automatically.
Common scenarios include:
- Adjusting tag properties like color or matching rules to improve document classification.
- Changing ownership or permissions on a tag to control access.
- Enabling or disabling automatic assignment of tags to new documents.
Practical example: You have a tag named "Invoices" and want to change its color to red (#FF0000) and set it as an inbox tag so that all newly scanned invoices are automatically tagged.
Properties
| Name | Meaning |
|---|---|
| Note (globalPermissionsNote) | Informational notice explaining that owner and permissions fields accept numeric IDs, and users/groups can be retrieved via separate endpoints. |
| Tag ID (id) | The unique numeric identifier of the tag to partially update. This is required to specify which tag to modify. |
| Name (name) | Optional new name for the tag. |
| Color (color) | Hex color code representing the tag's color (e.g., #FF0000). |
| Match (match) | A string pattern that Paperless NGX will try to match against document content to assign this tag automatically. |
| Matching Algorithm (matchingAlgorithm) | The algorithm used to match documents to this tag. Options include: None, Any, All, Literal, Regular Expression, Fuzzy Match, Auto (letting Paperless decide). Default is None. |
| Case Insensitive (isInsensitive) | Boolean indicating if the matching should ignore case differences. Default is false. |
| Is Inbox Tag (isInboxTag) | Boolean indicating whether this tag should be automatically assigned to new documents. Default is false. |
| Owner User ID (owner) | Numeric user ID to set as the owner of this tag. |
| Set Permissions (setPermissions) | JSON object defining view and change permissions for users and groups. Format: {"view":{"users":[],"groups":[]},"change":{"users":[],"groups":[]}}. Users and groups must be specified by their numeric IDs. |
Additional notes:
- There is a permissions note reminding users to use the Users and Groups endpoints to look up IDs for owner and permissions, as this node does not provide create/update/delete for users or groups.
Output
The node outputs JSON data representing the updated tag object after the partial update operation. This typically includes the tag's current state with any changes applied, such as updated name, color, matching settings, ownership, and permissions.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the Paperless NGX instance.
- The base URL for the API is configured from the credentials and defaults to the
/apipath of the Paperless NGX server. - To set owners or permissions, numeric user and group IDs must be obtained separately using the corresponding Users and Groups endpoints.
Troubleshooting
- Invalid Tag ID: If the provided tag ID does not exist, the API will likely return an error indicating the tag was not found. Verify the tag ID before attempting the update.
- Permission Errors: Insufficient permissions to update the tag may cause authorization errors. Ensure the API key has appropriate rights.
- Malformed Permissions JSON: The
setPermissionsproperty must be a valid JSON object with correct structure. Invalid JSON or incorrect keys will cause request failures. - Color Format Issues: The color must be a valid hex code (e.g.,
#FF0000). Incorrect formats may be rejected. - Matching Algorithm Values: Use only the predefined integer values for the matching algorithm; invalid values may cause errors.