Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
The node integrates with the Paperless NGX API to update an existing custom field. It allows users to modify properties such as the custom field's name, ownership, and permissions. This is useful in scenarios where metadata fields need to be adjusted after creation, for example, changing who owns a custom field or updating which users or groups have view or change permissions.
Practical examples:
- Updating the name of a custom field to better reflect its purpose.
- Changing the owner user ID to transfer responsibility.
- Adjusting permissions to restrict or grant access to specific users or groups.
Properties
| Name | Meaning |
|---|---|
| Note (globalPermissionsNote) | Informational note explaining that owner and permissions fields accept numeric IDs, and suggesting how to retrieve these IDs using Users and Groups endpoints. |
| Custom Field ID (id) | The numeric ID of the custom field to update. This is required to identify which custom field will be modified. |
| Name (name) | Optional new name for the custom field. |
| Owner User ID (owner) | Numeric user ID to set as the owner of this custom field. |
| Set Permissions (setPermissions) | JSON object defining permissions with structure: {"view":{"users":[],"groups":[]},"change":{"users":[],"groups":[]}}. Lists of user and group IDs specify who can view or change the custom field. |
| Note (permissionsNote) | Informational note reminding users to use the Users and Groups endpoints to look up IDs for owner and permissions, and clarifying that this node does not create/update/delete users or groups. |
Output
The node outputs JSON data representing the updated custom field as returned by the Paperless NGX API. This typically includes the custom field's ID, name, owner information, and permission settings reflecting the changes made.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the Paperless NGX API.
- The base URL for API requests is configured from the instance URL provided in credentials.
- Users must have access to the Users and Groups endpoints (via other nodes) to retrieve numeric IDs needed for owner and permissions fields.
Troubleshooting
Common issues:
- Providing invalid or non-existent custom field ID will cause update failure.
- Using incorrect user or group IDs in owner or permissions fields may result in permission errors.
- Missing or invalid API authentication token will prevent successful API calls.
Error messages and resolutions:
- "Custom field not found": Verify the custom field ID exists.
- "Unauthorized" or "Forbidden": Check API credentials and ensure the authenticated user has rights to update the custom field.
- "Invalid permissions format": Ensure the permissions JSON matches the expected structure with correct user/group ID arrays.
Links and References
- Paperless NGX API documentation (for details on custom fields, users, groups, and permissions)
- n8n documentation on creating and using API credentials
- Guides on managing user and group IDs within Paperless NGX