ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Actions33

Overview

The node integrates with the ZapSign API to manage digital document workflows, focusing on creating documents from templates. Specifically, the "Create Document From Template" operation allows users to generate a new document based on an existing template by providing template tokens and signer information. This is useful for automating contract generation, agreements, or any standardized document that requires dynamic data insertion and electronic signatures.

Typical use cases include:

  • Automatically generating contracts with personalized data for clients.
  • Sending templated documents for signature without manual intervention.
  • Managing signer details and customizing communication branding.

For example, a company can create a sales agreement document from a predefined template, replacing variables like customer name and address, then send it to the designated signer for electronic signature.

Properties

Name Meaning
Template Token The unique token identifying the template to use for document creation (required).
Document Name Optional name for the created document.
Signer Name Name of the signer who will sign the document (required).
Signer Email Email address of the signer (optional but recommended for email notifications).
Phone Country Code Country code for the signer's phone number, e.g., "55" for Brazil. Defaults to "55".
Phone Number Phone number of the signer (optional, used for SMS/WhatsApp notifications).
Template Data Collection of template variables to replace in the document. Each variable has a name (matching the template placeholder) and a value to insert.
Language Language of the document interface. Options: Portuguese ("pt-br"), Spanish ("es"), English ("en"). Default is Portuguese.
Disable Signer Emails Boolean flag to disable automatic emails sent to signers.
Brand Logo Public URL of a brand logo image to display in emails and documents.
Brand Primary Color Primary color for branding in RGB or hex format (e.g., "#0011ee").
Brand Name Brand name shown as the email sender (max 100 characters).
External ID An external identifier for the document in your own system.
Folder Path Path where the document will be stored (max 255 characters, supports up to 5 folder levels).
Created By Email of the user to set as the creator of the document.
Folder Token Token of the folder where the document will be placed; this takes priority over Folder Path if provided.
Disable Signers Get Original File Boolean to prevent signers from downloading the original file.
Send Automatic WhatsApp Boolean to send invitation via WhatsApp automatically (incurs cost per message).
Send WhatsApp Signed File Boolean to send the signed file via WhatsApp automatically (incurs cost per message).
Signature Order Active Boolean to enable sequential signing order among multiple signers.
Metadata Custom metadata key-value pairs attached to the document, visible in webhooks.
Template Additional Fields Additional optional fields for document creation such as language, reminders, refusal options, signature deadlines, and folder tokens.

Output

The node outputs JSON objects representing the response from the ZapSign API after creating the document from the template. The output typically includes:

  • Document token and identifiers.
  • Status and metadata of the created document.
  • Details about the signer(s).
  • Any additional information returned by the API regarding the document creation process.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ZapSign API.
  • Uses environment variables to determine the API base URL (ZAPSIGN_API_BASE_URL_SANDBOX for sandbox or ZAPSIGN_API_BASE_URL for production).
  • Relies on network access to ZapSign's REST API endpoints.

Troubleshooting

Common Issues

  • Missing or invalid Template Token: The template token must be provided and follow the expected UUID format. If missing or malformed, the request will fail.
  • Signer Name is required: The signer name cannot be empty; otherwise, the API rejects the request.
  • Invalid template variables: Variables must have both non-empty names and values. Empty or missing variables may cause warnings or errors.
  • Folder Token vs Folder Path: If both are provided, the folder token takes precedence. Ensure the correct folder identification is used.
  • API errors (400 Bad Request): Usually caused by invalid parameters such as expired tokens, missing required fields, or invalid variable names/values.
  • Network or authentication errors: Check API key validity and network connectivity.

Error Messages and Resolutions

  • Bad request - please check your parameters. Common issues:

    • Template token invalid or expired.
    • Missing or invalid signer name.
    • Invalid template variables.
    • Missing required fields.

    Resolution: Verify all required inputs, ensure template token is valid, and all variables are correctly specified.

  • Template token format may be invalid warning:

    Resolution: Confirm the token matches the UUID pattern (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

  • No valid template variables found warning:

    Resolution: Ensure each variable has both a name and a value.

Links and References

This summary covers the static analysis of the node's execute method for the "Template" resource and "Create Document From Template" operation, describing its purpose, input properties, output structure, dependencies, and common troubleshooting tips.

Discussion