Actions15
Overview
This node integrates with the ZapSign API to create a new digital document ready for signature. It uploads a file (such as a PDF) as a document in ZapSign, optionally applying custom branding and setting the interface language. This operation is useful when automating workflows that require sending documents for electronic signatures, such as contracts, agreements, or forms.
Practical examples:
- Automatically creating a contract document from a PDF file uploaded in a previous step.
- Uploading onboarding paperwork for new employees to be signed digitally.
- Generating customized branded documents for clients in their preferred language.
Properties
| Name | Meaning |
|---|---|
| Document Name | The name/title of the document being created. |
| File | The name of the binary property containing the file data to upload (e.g., "data"). |
| Additional Fields | Optional extra settings: • Brand ID: Custom branding identifier. • Locale: Language of the document interface. Options: English, Portuguese (Brazil), Spanish. |
Output
The output JSON contains the response from the ZapSign API after creating the document. This typically includes details about the newly created document such as its ID, status, creation date, and other metadata returned by the API.
No binary data is outputted in this operation.
Example output structure (simplified):
{
"id": "string",
"name": "string",
"status": "string",
"created_at": "string",
...
}
Dependencies
- Requires an API key credential for authenticating with the ZapSign API.
- The node uses the ZapSign REST API endpoint
/v1/documentsto create documents. - The input file must be provided as binary data in the specified binary property.
Troubleshooting
- Missing or invalid binary data: If the specified binary property does not contain valid file data, the node will fail. Ensure the binary property name matches the actual binary input.
- Authentication errors: If the API key credential is missing or invalid, requests will fail with authentication errors. Verify the API key configuration.
- Invalid additional fields: Providing unsupported values for brand ID or locale may cause API errors. Use only supported locales ("en", "pt-BR", "es").
- File format issues: The uploaded file should be a supported document type (commonly PDF). Unsupported formats might cause upload failures.
Links and References
- ZapSign API Documentation (for detailed API endpoints and parameters)
- n8n Binary Data Handling (for understanding how to provide binary files to nodes)