Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
This node integrates with the Paperless NGX API to manage correspondents, which are entities representing people or organizations associated with documents. The "Create Correspondent" operation allows users to add a new correspondent by specifying details such as name, matching criteria for automatic document assignment, ownership, and permissions.
Common scenarios include automating document classification by linking documents to specific correspondents based on content matching, managing access control by assigning owners and permissions, and maintaining an organized repository of correspondents for document processing workflows.
For example, a user can create a correspondent named "Acme Corp" with a match string "Acme Invoice" so that any document containing this phrase is automatically assigned to that correspondent. Permissions can be set to restrict who can view or modify this correspondent's data.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice: Owner and permissions fields accept numeric IDs. Users should retrieve available User and Group IDs using the respective endpoints before setting these fields. |
| Name | The name of the correspondent to create. This is a required string field. |
| Match | A string used by Paperless NGX to try to match against document contents for automatic assignment to this correspondent. |
| Matching Algorithm | The algorithm used to match documents to this correspondent automatically. Options include: - None (0): No automatic matching - Any (1): Match any word in the string - All (2): Match all words - Literal (3): Exact string match - Regular Expression (4) - Fuzzy Match (5) - Auto (6): Let system decide best method |
| Case Insensitive | Boolean flag indicating whether the matching should ignore case differences. |
| Owner User ID | Numeric user ID to assign as the owner of this correspondent. |
| Set Permissions | JSON object defining permissions for viewing and changing the correspondent. Structure:{"view":{"users":[],"groups":[]},"change":{"users":[],"groups":[]}}Users and groups are specified by their numeric IDs. |
| Note (Permissions) | Informational notice reminding users to use the Users and Groups endpoints to look up IDs for owner and permissions. This node does not provide create/update/delete operations for users or groups. |
Output
The node outputs JSON data representing the created correspondent as returned by the Paperless NGX API. This typically includes fields such as the correspondent's unique identifier, name, matching settings, ownership, and permissions.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a Paperless NGX instance via its REST API.
- An API authentication token or key credential must be configured in n8n to authorize requests.
- Users and groups referenced in ownership and permissions must exist in the Paperless NGX system; their numeric IDs need to be retrieved beforehand using appropriate nodes or API calls.
Troubleshooting
- Invalid or missing required fields: Ensure the "Name" property is provided; it is mandatory.
- Incorrect user or group IDs: Owner and permission fields require valid numeric IDs. Using invalid or non-existent IDs will cause errors. Retrieve these IDs from the Users and Groups endpoints before use.
- Matching algorithm misconfiguration: Selecting an inappropriate matching algorithm or malformed regular expressions may lead to unexpected behavior or errors.
- API connectivity issues: Verify that the API URL and credentials are correctly configured and that the Paperless NGX instance is reachable.
- Permission denied errors: If the API user lacks sufficient rights to create correspondents or assign ownership/permissions, the request will fail. Check API user roles and permissions.