ZapSign

Overview

This node integrates with the ZapSign API to manage electronic document workflows, including creation, updating, sending for signing, and deletion of documents. Specifically, the Document - Delete operation allows users to delete a document identified by its unique token.

Use cases for this node include automating document lifecycle management in business processes such as contract handling, approvals, or compliance workflows. For example, after a document is no longer needed or was created erroneously, you can programmatically delete it to keep your document repository clean.

Practical example:

• Automatically delete draft or obsolete documents from ZapSign after a certain period or event trigger in your workflow.

Properties

Output

The output of the delete operation is the JSON response returned by the ZapSign API after attempting to delete the specified document. This typically includes confirmation of deletion or details about the deleted document.

The json output field contains the API response object. There is no binary data output for this operation.

Example output structure (simplified):

{
  "success": true,
  "message": "Document deleted successfully",
  "documentToken": "the-deleted-document-token"
}

Dependencies

• Requires an API key credential for authenticating with the ZapSign API.
• The node uses environment variables to determine the API base URL:
  • ZAPSIGN_API_BASE_URL_SANDBOX for sandbox environment (default: https://sandbox.api.zapsign.com.br)
  • ZAPSIGN_API_BASE_URL for production environment (default: https://api.zapsign.com.br)
• Network access to the ZapSign API endpoints is necessary.

Troubleshooting

Common Issues

• Invalid or missing Document Token: The delete operation requires a valid document token. If omitted or incorrect, the API will reject the request.
• Authentication errors: Ensure the API key credential is correctly configured and has permissions to delete documents.
• Network issues: Connectivity problems to the ZapSign API endpoint may cause failures.
• API errors: The ZapSign API might return errors if the document is already deleted or cannot be found.

Error Messages

• 400 Bad Request: Usually indicates the document token is invalid or the document cannot be deleted due to its current state.
• 401 Unauthorized / 403 Forbidden: Authentication failure or insufficient permissions.
• 404 Not Found: The document token does not correspond to any existing document.
• Other HTTP errors: Check network connectivity and API status.

To resolve errors:

• Verify the document token is correct and corresponds to an existing document.
• Confirm API credentials are valid and have delete permissions.
• Check the document's status to ensure it is deletable.
• Review API limits or restrictions imposed by your ZapSign plan.

Links and References

• ZapSign API Documentation (official API docs for detailed endpoint info)
• ZapSign Node on n8n Community (for community support and examples)

This summary focuses exclusively on the Document - Delete operation as requested, based on static analysis of the provided source code and property definitions.