ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Actions33

Overview

The node provides integration with a document signing and management service, allowing users to update existing documents within their account. The "Update Document" operation enables modifying key attributes of a document such as its name, signature deadline, folder organization, and renaming associated extra documents.

This operation is useful in scenarios where you need to:

  • Change the document's display name after creation.
  • Adjust the deadline by which signers must complete their signatures.
  • Reorganize documents into different folders for better management.
  • Rename additional related documents attached to the main document.

For example, if a document was initially created with a placeholder name or an incorrect deadline, this operation allows updating those details without recreating the document. Similarly, if your folder structure changes, you can move the document accordingly.

Properties

Name Meaning
Document Token The unique token identifying the document to update (required).
New Document Name The new name to assign to the document.
New Date Limit to Sign The updated deadline date for signing the document, in YYYY-MM-DD format.
New Folder Path The new folder path where the document should be organized.
New Folder Token The token of the folder to move the document into; overrides New Folder Path if provided.
Extra Documents to Rename A collection of extra documents linked to the main document that can be renamed. Each entry includes:
- Extra Document Token: Token of the extra document.
- New Extra Document Name: New name for the extra document.

Output

The node outputs a JSON array where each element corresponds to the result of processing an input item. For the "Update Document" operation, the output JSON contains the response from the API reflecting the updated document details.

Typical fields in the output JSON include confirmation of the updated properties and any metadata returned by the API. The node does not output binary data for this operation.

Example output snippet (simplified):

{
  "id": "document-token-123",
  "name": "Updated Document Name",
  "date_limit_to_sign": "2024-12-31",
  "folder_path": "/new/folder/path",
  "extra_docs": [
    {
      "token": "extra-doc-token-1",
      "name": "Renamed Extra Document"
    }
  ],
  "status": "updated"
}

Dependencies

  • Requires an API key credential for authenticating with the external document signing service.
  • Uses environment variables to determine the API base URL depending on the environment (sandbox or production).
  • Relies on HTTP requests to the service's REST API endpoints.

Troubleshooting

Common Issues

  • Invalid or missing Document Token: The update request will fail if the document token is invalid or not provided.
  • Incorrect date format: The "New Date Limit to Sign" must be in YYYY-MM-DD format; otherwise, the API may reject the request.
  • Folder token vs. folder path conflict: If both folder token and folder path are provided, the folder token takes precedence. Ensure the folder token is valid.
  • Empty or malformed extra documents collection: When renaming extra documents, ensure tokens and new names are correctly specified.

Error Messages

  • 400 Bad Request: Usually indicates invalid input parameters such as wrong date format, invalid tokens, or malformed JSON in extra documents. Verify all inputs carefully.
  • Authentication errors: Occur if the API key credential is missing or invalid.
  • Network or API endpoint errors: Check connectivity and correct API base URL configuration.

To resolve errors:

  • Double-check all required fields are filled and correctly formatted.
  • Validate tokens and paths exist in your account.
  • Review API documentation for field constraints.
  • Enable detailed logging to inspect request payloads and responses.

Links and References

Discussion