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 manage documents and related resources. Specifically, for the Document - Delete operation, it allows users to delete a document by specifying its unique numeric ID. This is useful in workflows where automated cleanup or removal of outdated or incorrect documents is required.
Practical examples include:
- Automatically deleting documents after processing or archiving.
- Removing duplicate or erroneous documents based on business logic.
- Integrating with other systems to maintain synchronized document states.
Properties
| Name | Meaning |
|---|---|
| Note | Informational notice explaining that Owner and permissions fields accept numeric IDs. It suggests retrieving available Users and Groups via provided API endpoints using this or other nodes. |
| Document ID | The unique numeric identifier of the document to delete. This property is required to specify which document will be removed from the system. |
Output
The node outputs JSON data representing the result of the delete operation. Typically, this includes confirmation of deletion or any error messages returned by the API. There is no indication that binary data is outputted for this operation.
Dependencies
- Requires an API key credential for authenticating with the Paperless NGX API.
- The base URL for the API instance must be configured in the credentials.
- The node depends on the Paperless NGX API being accessible and properly configured to allow document deletion.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Document ID will likely cause the API to return an error.
- Insufficient permissions or missing API authentication can lead to authorization errors.
- Network connectivity problems may prevent successful API calls.
Error messages and resolutions:
- "Document not found": Verify the Document ID is correct and exists.
- "Unauthorized" or "Forbidden": Check API credentials and user permissions.
- Timeout or network errors: Ensure the API endpoint is reachable and stable.
Links and References
- Paperless NGX API Documentation (for detailed API usage)
- n8n documentation on creating custom nodes