Overview

The node integrates with the ZapSign API to manage electronic document workflows, including templates, documents, signers, background checks, partnerships, timestamps, and webhooks. Specifically, for the Template resource and the Update Template Form operation, this node allows users to update the form inputs (variables) of an existing template by specifying a collection of input fields.

This operation is useful when you want to customize or modify the variables that a template expects for document generation, such as adding new fields, changing labels, setting required flags, or defining input types. For example, if you have a contract template and want to add a new variable for "Client Address" with a help text and mark it as required, you can use this operation to update the template form accordingly.

Properties

Output

The output JSON contains the response from the ZapSign API after updating the template form inputs. Typically, this will include confirmation of the update and possibly the updated template form details.

The node does not output binary data for 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 (optional sandbox URL)
  • ZAPSIGN_API_BASE_URL (production URL fallback)
• The node makes HTTP POST requests to the endpoint /api/v1/templates/update-form/ on the selected base URL.

Troubleshooting

• Missing or Invalid Template Token: If the template token is missing or invalid, the API request will fail. Ensure the token is provided and correctly formatted.
• Empty or Malformed Inputs Collection: The inputs array must contain valid objects with at least the variable property set. Empty or improperly structured inputs may cause the API to reject the request.
• API Errors: If the API returns errors, check the logs for detailed messages. Common issues include expired tokens, permission issues, or malformed request bodies.
• Network Issues: Ensure the node can reach the ZapSign API endpoints and that any firewall or proxy settings allow outbound HTTPS traffic.
• Error Handling: If the node is configured to continue on failure, errors will be returned in the output array with error messages; otherwise, execution will stop on the first error.

Links and References

• ZapSign API Documentation (general reference for API endpoints and parameters)
• ZapSign Templates API (specific documentation about template management and form inputs)

Summary of execute() logic for Template - Update Template Form

When the node executes with Resource=template and Operation=updateTemplateForm, it:

1. Retrieves the templateToken parameter (required).
2. Retrieves the templateFormInputs fixed collection parameter, extracting the array of inputs.
3. Constructs a request body object with:
   • template_id set to the template token.
   • inputs set to an array mapped from the inputs collection, each containing:
     • variable
     • label
     • help_text
     • input_type
     • options
     • required
     • order
4. Sends a POST request to ${baseUrl}/api/v1/templates/update-form/ with the constructed body as JSON.
5. Pushes the API response into the output array.
6. Handles any errors by logging and throwing or continuing based on node configuration.
7. Returns the collected results as JSON output.

This operation updates the form inputs (variables) of the specified template in ZapSign.