Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node integrates with the Paperless NGX API to perform a partial update on a Correspondent entity. This operation allows users to modify selected fields of an existing correspondent without needing to provide all details, making it efficient for incremental updates.

Common scenarios include:

  • Updating the name or matching criteria of a correspondent after initial creation.
  • Adjusting permissions or ownership of a correspondent dynamically.
  • Refining document matching rules to improve automatic assignment accuracy.

Practical example:

  • A user wants to change the matching algorithm and add a new owner to a correspondent without altering other properties. Using this node's partial update operation, they can specify only those fields to update.

Properties

Name Meaning
Note (globalPermissionsNote) Informational notice that Owner and Permissions fields accept numeric IDs. Users should retrieve available User and Group IDs via separate API calls or nodes.
Name (name) The name of the correspondent. Optional in partial update; if provided, it will replace the current name.
Match (match) A string used by Paperless NGX to match documents automatically to this correspondent.
Matching Algorithm (matchingAlgorithm) The algorithm used to match documents to this correspondent. Options: None, Any, All, Literal, Regular Expression, Fuzzy Match, Auto (let system decide). Defaults to None.
Case Insensitive (isInsensitive) Boolean flag indicating whether the matching should ignore case differences. Defaults to false.
Owner User ID (owner) Numeric user ID to set as the owner of this correspondent.
Set Permissions (setPermissions) JSON object defining view and change permissions for users and groups. Format: {"view":{"users":[],"groups":[]},"change":{"users":[],"groups":[]}}. Defaults to empty arrays.
Note (permissionsNote) Informational notice reminding users to use separate endpoints to look up User and Group IDs for owner and permissions settings. No create/update/delete operations for users/groups are provided by this node.
Correspondent ID (id) Required. The numeric ID of the correspondent to update.

Output

The node outputs the JSON response from the Paperless NGX API corresponding to the updated correspondent object. This typically includes the updated fields of the correspondent such as its ID, name, matching parameters, ownership, and permissions.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Paperless NGX API instance.
  • Needs an API authentication token or key configured in the node credentials.
  • Users must have access to User and Group IDs externally, as this node does not provide user/group management capabilities.
  • The base URL for the API is derived from the credential configuration.

Troubleshooting

  • Missing or invalid correspondent ID: The operation requires a valid correspondent ID. Ensure the ID exists and is correctly specified.
  • Invalid permission or owner IDs: Since owner and permissions require numeric IDs, providing incorrect or non-existent user/group IDs will cause errors. Use separate nodes or API calls to verify these IDs.
  • API authentication errors: Verify that the API key/token is correctly configured and has sufficient permissions.
  • Malformed JSON in permissions: The setPermissions field expects a well-formed JSON object. Invalid JSON syntax will cause request failures.
  • Matching algorithm value out of range: Ensure the matching algorithm option is one of the predefined values (0-6).
  • Network or connectivity issues: Confirm that the Paperless NGX instance URL is reachable and correct.

Links and References

Discussion