DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions23

Overview

The node integrates with the DocuSeal API to manage document templates and their associated documents. Specifically, the Update Documents operation for the Template resource allows users to update the documents attached to an existing template by either uploading new files from previous workflow nodes (binary data) or specifying URLs of files to be linked.

This operation is useful when you want to modify the set of documents that a template uses without recreating the entire template. For example, if you have a contract template and need to update its supporting PDF files or add new versions, this operation lets you do so programmatically within an n8n workflow.

Practical scenarios include:

  • Automatically updating template documents after generating or modifying files in earlier workflow steps.
  • Linking external document URLs to a template for dynamic content referencing.
  • Managing document versions in bulk by providing multiple binary files or URLs at once.

Properties

Name Meaning
Template ID The unique numeric identifier of the template whose documents you want to update.
Documents Source The source of the documents to update: either Binary Files (files from previous nodes) or URLs (external file links).
Binary Properties (Required if using Binary Files) Comma-separated list of binary property names containing the files to upload. Example: data,attachment1.
File URLs (Required if using URLs) Comma-separated list of valid URLs pointing to the document files to link to the template.

Output

The output JSON contains the response from the DocuSeal API after updating the template's documents. This typically includes confirmation details about the updated documents or the updated template metadata.

If binary files are used as input, the node uploads these files but does not output binary data itself; the output remains JSON describing the result of the update operation.

Dependencies

  • Requires an active connection to the DocuSeal API via an API key credential configured in n8n.
  • The node depends on helper functions to prepare binary data and validate URLs before sending requests.
  • Network access to the DocuSeal API endpoint and any external URLs provided is necessary.

Troubleshooting

  • Invalid URL error: If any URL provided in the "File URLs" property is invalid or unreachable, the node will throw an error indicating which URL failed validation. Ensure all URLs are correct and accessible.
  • Missing binary data: When using binary files as the source, ensure that the specified binary properties exist in the incoming data and contain valid file data.
  • Empty update fields: If no documents are provided or the list is empty, the API request may fail or have no effect. Always provide at least one binary property or URL.
  • API errors: Errors returned from the DocuSeal API (e.g., authentication issues, permission denied) will be surfaced as node execution errors. Verify your API credentials and permissions.
  • Continue on Fail: If enabled, the node will continue processing other items even if one fails, returning error messages in the output JSON.

Links and References

Discussion