Actions33
- Template Actions
- Document Actions
- Signer Actions
- Background Check Actions
- Partnership Actions
- Timestamp Actions
- Webhook Actions
Overview
The "Add Extra Document" operation in the Document resource allows users to attach an additional PDF document to an existing envelope/document in the ZapSign system. This is useful when you need to supplement a primary document with extra information or attachments after the original document has been created or sent.
Typical use cases include:
- Adding appendices, annexes, or supplementary agreements to an ongoing signing process.
- Attaching supporting documents that were not available at the time of initial document creation.
- Dynamically adding extra PDFs to an envelope before finalizing or sending it for signing.
For example, if you have a contract already sent out for signature but later want to add a related terms and conditions PDF, this operation lets you upload that extra document either by providing a public URL or base64 content.
Properties
| Name | Meaning |
|---|---|
| Document Token | The unique token identifying the main document/envelope to which the extra document will be added. |
| Extra Document Name | Title of the extra document (up to 255 characters). |
| Extra Document File Input Type | Method to provide the extra document file: either a Public URL or Base64 encoded string. |
| Extra Document URL | Publicly accessible URL pointing to the PDF file (required if file input type is URL). |
| Extra Document Base64 Content | PDF file content encoded as a base64 string (required if file input type is Base64). |
Output
The node outputs a JSON array where each element corresponds to the API response for the processed item. For the "Add Extra Document" operation, the output JSON contains the details returned by the ZapSign API after successfully uploading the extra document to the specified envelope/document.
The structure typically includes confirmation of the upload, tokens or IDs for the extra document, and any metadata or status information provided by the API.
This operation does not produce binary data output.
Dependencies
- Requires an active connection to the ZapSign API using valid credentials that include an API authentication token.
- The node uses environment variables to determine the API base URL depending on the environment (sandbox or production).
- The extra document must be a PDF file up to 10MB in size.
- If providing a URL, the PDF must be publicly accessible without authentication.
Troubleshooting
Common Issues
- Invalid or missing Document Token: The operation requires a valid document token to identify the target envelope. Ensure the token is correct and active.
- File size or format issues: Only PDF files up to 10MB are supported. Larger files or unsupported formats will cause errors.
- URL accessibility: When using a public URL, the file must be accessible without restrictions. Private or protected URLs will fail.
- Base64 encoding errors: The base64 string must correctly encode a valid PDF file. Corrupted or incomplete base64 data will cause failures.
Error Messages
- 400 Bad Request: Usually indicates invalid parameters such as missing required fields, invalid document token, or incorrect file format. Verify all inputs carefully.
- Authentication errors: If the API key or credentials are invalid or expired, requests will fail. Check credential configuration.
- File download failure: If the node cannot fetch the file from the provided URL, it throws an error indicating the download failed. Confirm the URL is correct and accessible.
Links and References
- ZapSign API Documentation (general reference for API endpoints and parameters)
- ZapSign Add Extra Document API Endpoint (specific endpoint details)
This summary is based solely on static analysis of the node's source code and provided property definitions. It reflects the logic implemented for the "Add Extra Document" operation within the Document resource.