Actions12
- Document Actions
- Template Actions
- Webhook Actions
Document → Delete
AI-generatedOverview
This node operation deletes a document in the SignWell platform by its document ID. It is useful for scenarios where you need to programmatically remove documents that are no longer needed or were created in error. For example, you might use this operation to clean up draft documents or remove outdated contracts.
Use Case Examples
- Deleting a document by specifying its document ID to free up storage or maintain document organization.
- Automating document lifecycle management by removing documents after a certain workflow step.
Properties
| Name | Meaning |
|---|---|
| Document ID | The unique identifier of the document to be deleted. This is a required input to specify which document to remove. |
Output
JSON
id- The ID of the deleted document, confirming which document was removed.status- The status of the delete operation, typically indicating success or failure.
Dependencies
- Requires an API key credential for authenticating with the SignWell API.
Troubleshooting
- Common issues include providing an invalid or non-existent Document ID, which will result in an error from the API indicating the document could not be found.
- API authentication errors if the API key credential is missing or invalid, resulting in authorization failures.
- Network or connectivity issues that prevent the node from reaching the SignWell API endpoint.
Links
- SignWell API Documentation - Official API documentation for SignWell, useful for understanding the delete document endpoint and required parameters.