ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Overview

This node integrates with the ZapSign API to manage digital document workflows, including templates, documents, signers, background checks, partnerships, timestamps, and webhooks. Specifically, for the Template resource and Delete Template operation, the node deletes a template identified by its token from the ZapSign system.

Use cases include automating the removal of outdated or incorrect document templates in your digital signature workflow. For example, if a template is no longer valid or needs to be replaced, this operation allows you to programmatically delete it, keeping your template library clean and up-to-date.

Properties

Name Meaning
Template Token The unique token (identifier) of the template to delete. This is required and must be provided.

Output

The output JSON contains the response from the ZapSign API after attempting to delete the specified template. Typically, this will confirm whether the deletion was successful or provide error details if it failed.

No binary data output is involved in this operation.

Example output structure (simplified):

{
  "success": true,
  "message": "Template deleted successfully"
}

or in case of failure:

{
  "error": "Template not found or already deleted"
}

Dependencies

  • Requires an active connection to the ZapSign API via an API key credential.
  • The node uses environment variables to determine the API base URL:
    • ZAPSIGN_API_BASE_URL_SANDBOX for sandbox environment (optional)
    • ZAPSIGN_API_BASE_URL for production environment (default: https://api.zapsign.com.br)
  • Proper permissions on the ZapSign account to delete templates are necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or empty template token will cause the operation to fail.
    • Lack of proper permissions or API access rights may result in authorization errors.
    • Network connectivity issues can prevent communication with the ZapSign API.
  • Error messages:

    • If the template token is invalid or does not exist, the API may return a 404 or similar error.
    • If the API returns a 400 Bad Request, verify that the token format matches the expected UUID pattern.
    • Authorization errors (e.g., 401 or 403) indicate issues with the API key or account permissions.
  • Resolution tips:

    • Ensure the template token is correctly copied and formatted.
    • Confirm that the API key used has sufficient privileges.
    • Check network connectivity and API endpoint configuration.
    • Review ZapSign API documentation or contact support if persistent errors occur.

Links and References


This summary focuses exclusively on the Template resource's Delete Template operation as requested.

Discussion