Actions33
- Template Actions
- Document Actions
- Signer Actions
- Background Check Actions
- Partnership Actions
- Timestamp Actions
- Webhook Actions
Overview
The node integrates with the ZapSign API to manage electronic document workflows, including creation, signing, updating, and refusal of documents. Specifically, the Document Refuse operation allows users to refuse a document that is currently in progress, providing a reason for refusal which is recorded in the document's history.
This operation is useful in scenarios where a recipient or user needs to formally reject signing or processing a document, ensuring the refusal is logged and traceable. For example, if a contract or agreement sent for signature is not acceptable, the user can refuse it with a reason, preventing further processing.
Properties
| Name | Meaning |
|---|---|
| Document Token | The unique token identifying the document to be refused. Required to specify which document to refuse. |
| Rejected Reason | The reason for refusing the document. This text is stored in the document's history for audit and tracking purposes. |
Output
- The output JSON contains the response from the ZapSign API after attempting to refuse the document.
- Typically, this includes confirmation of the refusal action or error details if the refusal failed.
- No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the ZapSign API.
- Uses environment variables to determine the base URL for the API:
ZAPSIGN_API_BASE_URL_SANDBOX(for sandbox environment)ZAPSIGN_API_BASE_URL(for production environment)
- The node makes HTTP POST requests to the
/api/v1/refuse/endpoint of the ZapSign API.
Troubleshooting
Common Issues
- 400 Bad Request Error on Refusal:
- The document may not be in a state that allows refusal (must be "In progress").
- The document might not have been created with refusal permission enabled (
allow_refuse_signature). - The document could be completed, expired, or otherwise invalid for refusal.
- The provided document token might be invalid or inactive.
Error Messages and Resolutions
- "Document cannot be refused (400 Bad Request)"
- Verify the document status is "In progress".
- Confirm the document was created with refusal allowed.
- Check the validity and correctness of the document token.
- Ensure the document is not already signed, canceled, or expired.
If these conditions are met and the error persists, consult ZapSign support or review API documentation for additional constraints.
Links and References
- ZapSign API Documentation (general reference, actual URL may vary)
- ZapSign API
/refuse/endpoint for refusing documents.
This summary focuses exclusively on the Document Refuse operation as requested, based on static analysis of the provided source code and property definitions.