ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Actions33

Overview

The node integrates with the ZapSign API to manage electronic document templates and related operations. Specifically, for the Template resource and Update Template operation, it allows updating an existing template's metadata and configuration on the ZapSign platform.

This operation is useful when you want to modify properties of a stored template such as its name or additional settings without recreating it. For example, you might update branding details, language preferences, folder organization, or signature-related options for a template used in your document workflows.

Practical scenarios include:

  • Renaming a template to better reflect its purpose.
  • Changing the default language or branding colors for documents generated from the template.
  • Adjusting folder paths or tokens to reorganize templates within ZapSign.
  • Updating signature order or reminder settings to fit new business rules.

Properties

Name Meaning
Template Token The unique token identifier of the template to update (required).
Document Name New name for the template (optional).
Template Additional Fields A collection of optional fields to update various template settings:
- Language Language for the document interface; options: Portuguese (Brazil), English, Spanish.
- Disable Signer Emails Whether to disable automatic emails sent to signers (boolean).
- Brand Logo URL Public URL of the brand logo image to use in emails/documents.
- Brand Primary Color Primary brand color in RGB or hex format (e.g., "#0011ee").
- Brand Name Brand name to appear in emails (max 100 characters).
- External ID External identifier for the document in your application.
- Folder Path Folder path in ZapSign where the template is organized; missing folders will be created.
- Date Limit to Sign Signature deadline date in YYYY-MM-DD format.
- Signature Order Active Enable or disable sequential signature ordering (boolean).
- Reminder Every N Days Number of days between automatic reminders; 0 disables reminders.
- Allow Refuse Signature Allow signer to refuse the document (boolean).
- Created By Email of the user who will be set as the document creator.
- Signer Has Incomplete Fields Indicates if the signer has incomplete fields to fill (boolean).
- Allow Signer Refusal Whether signers can refuse to sign the document (boolean).
- Disable Signers Get Original File Whether signers can download the original document (boolean).
- Send Automatic WhatsApp Whether to automatically send WhatsApp messages to signers (may incur cost) (boolean).
- Send Automatic WhatsApp Signed File Whether to automatically send signed file via WhatsApp (may incur cost) (boolean).
- Folder Token Folder token that overrides folder_path if provided (password type string).

Output

The node outputs a JSON array containing the response from the ZapSign API after attempting to update the template. The structure typically includes:

  • Confirmation of the updated template data.
  • Updated fields reflecting changes made.
  • Status or success indicators from the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active ZapSign API credential configured in n8n with appropriate permissions.
  • 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 HTTP requests to the ZapSign REST API endpoints.

Troubleshooting

Common Issues

  • Invalid or missing Template Token: The update operation requires a valid template token. Ensure the token is correctly provided and matches the expected UUID format.
  • API authentication errors: Verify that the API credentials are correct and have permission to update templates.
  • Invalid field values: Some fields like colors, dates, or URLs must be properly formatted. Invalid inputs may cause the API to reject the request.
  • Network or connectivity issues: Ensure the node can reach the ZapSign API endpoints.

Error Messages

  • 400 Bad Request: Usually indicates invalid input parameters or missing required fields. Check the error message for details and verify all inputs.
  • 401 Unauthorized / 403 Forbidden: Authentication failure or insufficient permissions. Confirm API credentials and access rights.
  • 404 Not Found: The specified template token does not exist or is inaccessible.
  • Other HTTP errors: Refer to ZapSign API documentation or support for specific status codes.

Links and References

If you need further details about other operations or resources, feel free to ask!

Discussion