Skip to main content
DocuSeal logo
  • Category: signatures
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 23
  • Triggers: 0
  • Slug: DOCUSEAL
  • Version: 20261101_00

Tools

Slug: DOCUSEAL_ARCHIVE_SUBMISSIONTool to archive a submission by its unique identifier. Archived submissions are not permanently deleted and can be restored.

Input Parameters

integer
required
The unique identifier of the submission to be archived

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_ARCHIVE_TEMPLATETool to archive a specific template by its unique identifier. Use after verifying the template ID.

Input Parameters

string
required
The unique identifier of the template to be archived

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CLONE_TEMPLATE2Tool to clone an existing template into a new template with optional custom name, folder, and external_id. Use when you need to duplicate a template with specific customization options.

Input Parameters

integer
required
The unique identifier of the documents template to clone.
string
Template name. Existing name with (Clone) suffix will be used if not specified.
string
Your application-specific unique string key to identify this template within your app.
string
The folder’s name to which the template should be cloned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CREATE_SUBMISSIONTool to create signature requests (submissions) from an existing document template and send them to submitters. Use this when you have a pre-configured template and want to send it for signing to one or more parties. Supports email and SMS notifications, custom messages, field pre-filling, and sequential or simultaneous signing workflows.

Input Parameters

string ("preserved" | "random")
Order in which submitters should sign the document.
object
Custom email message for signature request.
string
Reply-To email address for signature request notification emails.
boolean
Set to true to send signature requests via SMS. Default is false.
string
Expiration date and time after which the submission becomes unavailable for signing. Format: ISO 8601 or ‘YYYY-MM-DD HH:MM:SS TZ’.
boolean
Set to false to disable signature request emails. Default is true.
array
required
List of submitters (signers) for the submission. At least one submitter is required.
integer
required
The unique identifier of the template to create a submission from. Templates must be created in advance via the Web UI or API.
string
BCC email address to receive a copy of completed signed documents.
string
URL to redirect submitters to after they complete signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CREATE_SUBMISSION_FROM_DOCXTool to create a one-off submission (signature request) from a DOCX document with dynamic content variables. Use [[variable_name]] text tags in the DOCX to define dynamic content variables and {{Field Name;role=Signer1;type=date}} text tags to define fillable fields. This allows you to generate personalized documents with pre-filled content and signature fields extracted from the DOCX file.

Input Parameters

object
DOCX file to upload for the submission. Either ‘docx’ or ‘docx_url’ or ‘documents’ must be provided.
string
Name for the submission document. If not provided, the DOCX filename or ‘document.docx’ will be used.
string
Order in which submitters should sign: ‘preserved’ (in order) or ‘random’ (any order). Defaults to ‘preserved’.
object
Custom email message content.
string
Public URL to a downloadable DOCX file. Either ‘docx’ or ‘docx_url’ or ‘documents’ must be provided. The URL must be publicly accessible.
string
Reply-to email address for notification emails
boolean
Whether to send SMS notifications to submitters
array
Array of documents with name and file (base64 or URL). Use this for multi-document submissions. Either ‘docx’ or ‘docx_url’ or ‘documents’ must be provided.
string
ISO 8601 datetime when the submission expires (e.g., ‘2024-12-31T23:59:59Z’)
object
Dynamic content variables object. Use [[variable_name]] text tags in DOCX to define variables. Variable values can be strings, numbers, arrays, objects, or HTML content for styled text, paragraphs, and tables.
boolean
Whether to send email notifications to submitters. Defaults to true.
array
required
List of submitters (signers) for the document. At least one submitter with email or phone is required.
boolean
Pass false to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing. Defaults to true.
array
Array of template IDs to use in the submission along with the provided documents. Use this to create multi-document submissions when some documents exist within templates.
string
Email address to BCC when the submission is completed
boolean
Set true to merge the documents into a single PDF file. Defaults to false.
string
URL to redirect the submitter to after signing is completed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CREATE_SUBMISSION_FROM_HTMLTool to create a one-off submission request from HTML content with embedded field tags rendered as a fillable and signable form. Use this when you want to create a signature request directly from HTML without first creating a reusable template. Field tags in HTML (like {{field_name}} or <signature-field>) will be automatically converted to fillable form fields.

Input Parameters

string
Name for the submission
string ("preserved" | "random")
Order in which submitters should sign the document.
object
Custom email message for submission request.
string
Reply-to email address for notification emails
boolean
Whether to send SMS notifications to submitters. Defaults to false in API.
array
required
List of HTML documents to include in the submission. Each document can have embedded field tags. At least one document required.
string
Expiration date and time after which submission becomes unavailable. Format: ‘YYYY-MM-DD HH:MM:SS UTC’
boolean
Whether to send email notifications to submitters. Defaults to true in API.
array
required
List of submitters (signers) who will fill and sign the document. At least one submitter required.
array
Optional array of template IDs to include in the submission along with HTML documents for multi-document submissions
string
Email address to BCC when the submission is completed by all parties
boolean
Set true to merge all documents into a single PDF file. Defaults to false.
string
URL to redirect submitters to after they complete signing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CREATE_SUBMISSION_FROM_PDFTool to create a one-off submission (signature request) from a PDF file. Use this to upload a PDF document and send it for electronic signature without creating a reusable template first. You can define signature fields and other form fields either by using text tags in the PDF (e.g., {{Signature;role=First Party;type=signature}}) or by specifying field coordinates in the request.

Input Parameters

object
PDF file to upload for the submission. Either ‘pdf’ or ‘pdf_url’ must be provided.
string
Name for the submission document. If not provided, the PDF filename or ‘document.pdf’ will be used.
string
Order in which submitters should sign: ‘preserved’ (in order) or ‘random’ (any order). Defaults to ‘preserved’.
array
List of field definitions with coordinates. Use this to specify where signature, text, and other fields should appear. Alternatively, you can use text tags in the PDF like {{Field Name;role=First Party;type=signature}}
object
Custom email message with ‘subject’ and ‘body’ keys
string
Public URL to a downloadable PDF file. Either ‘pdf’ or ‘pdf_url’ must be provided. The URL must be publicly accessible.
string
Reply-to email address for notification emails
boolean
Whether to send SMS notifications to submitters
string
ISO 8601 datetime when the submission expires (e.g., ‘2024-12-31T23:59:59Z’)
boolean
Whether to send email notifications to submitters. Defaults to true.
array
required
List of submitters (signers) for the document. At least one submitter with email or phone is required.
string
Email address to BCC when the submission is completed
string
URL to redirect the submitter to after signing is completed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CREATE_SUBMISSIONS_FROM_EMAILSCreate submissions from a document template for specified email addresses, with optional signature request emails and a custom message. The response contains the created submitters and their signing links.

Input Parameters

string
required
A comma-separated list of email addresses to send the submission to.
object
Custom email message for signature request.
boolean
Set false to disable signature request emails sending. Defaults to true.
integer
required
The unique identifier of the template to create submissions from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CREATE_TEMPLATE_FROM_DOCXTool to create a fillable document template from a Microsoft Word DOCX file. Use when you need to convert a DOCX document with field tags into a template.

Input Parameters

string
Name for the created template. If not provided, a name will be auto-generated.
array
required
Array of DOCX documents to create the template from. Each document must have a name and file (base64 or URL). Use {{Field Name;role=Signer1;type=date}} text tags in the DOCX to define fillable fields.
string
Application-specific unique identifier. If a template with this external_id already exists, it will be updated with the new document.
string
Folder name to create the template in. If the folder doesn’t exist, it will be created.
Set to true to make the template available via a shared link. This allows anyone with the link to create a submission from this template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CREATE_TEMPLATE_FROM_HTML2Tool to create a fillable document template from HTML content with pre-defined fields. Use when you need to create a template directly from HTML with custom field tags for text, signatures, dates, and other fillable elements.

Input Parameters

string
HTML template with field tags. Use custom HTML tags for fillable fields: <text-field>, <signature-field>, <date-field>, <initials-field>, <checkbox-field>, <image-field>, <file-field>, <select-field>, <radio-field>, <cells-field>, <stamp-field>, <payment-field>. Field attributes: name (field name), role (submitter role, e.g., ‘First Party’), required (true/false), default (default value), readonly (true/false), style (CSS for sizing/positioning). Either html or documents parameter is required (not both).
string
Name of the template. A random UUID will be assigned if not specified.
string ("Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6")
Page size options for the document template.
array
Array of documents with HTML content. Use this to create a template with multiple documents. Leave empty when using the top-level html parameter for a single document template. Either html or documents parameter is required (not both).
string
Your application-specific unique string key to identify this template within your app. If provided and matches an existing template, that template will be updated with the new HTML.
string
Folder name to create the template in. Folder will be created if it doesn’t exist.
HTML template of the footer to be displayed on every page.
string
HTML template of the header to be displayed on every page.
Set to true to make the template available via a shared link. This allows anyone with the link to create a submission from this template. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_CREATE_TEMPLATE_FROM_PDFTool to create a fillable document template from a PDF file. Use when you need to create a reusable template from a PDF. Fields can be defined using {{Field Name;role=Signer1;type=date}} text tags in the PDF or by specifying pixel coordinates.

Input Parameters

string
Name for the created template. If not provided, a default name is assigned.
boolean
Set to true to remove PDF form fields from the documents. This is useful for PDFs that have existing form fields that you want to replace with DocuSeal fields. Defaults to false.
array
required
Array of PDF documents to include in the template. Each document must have a name and either a ‘file’ (URL or base64) or ‘pdf’ property. Use text tags like {{Field Name;role=Signer1;type=date}} in the PDF or provide field coordinates.
string
Your application-specific unique string key to identify this template within your app. If a template with this external_id already exists, it will be updated with the new PDF instead of creating a duplicate.
string
Name of the folder to place the template in. The folder will be created if it doesn’t exist.
boolean
Set to false to disable the removal of {{text}} tags from the PDF after processing. This can be used with transparent text tags for faster PDF processing. Defaults to true (tags are removed).
Set to true to make the template available via a shared link that allows anyone with the link to create a submission. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_GET_SUBMISSIONTool to retrieve detailed information about a specific submission. Use when you need to fetch complete submission details including submitters, documents, status, template, events, and metadata.

Input Parameters

integer
required
The unique identifier of the submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_GET_SUBMISSION_DOCUMENTSTool to retrieve documents for a submission. Returns partially filled documents if the submission is in progress, or final signed documents if completed. Use when you need to download submission documents.

Input Parameters

integer
required
The unique identifier of the submission. You can get submission IDs from the List Submissions action.
boolean
When true, merges all documents into a single PDF. Returns individual documents when false or omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_GET_SUBMITTERTool to retrieve detailed information about a submitter by ID. Use when you need to fetch submitter details including documents, field values filled by the signer, submission events, and status.

Input Parameters

integer
required
The unique identifier of the submitter to retrieve. You can get submitter IDs from the List Submitters action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_GET_TEMPLATETool to retrieve details of a specific template by its unique identifier. Use when you need to fetch template metadata by ID.

Input Parameters

integer
required
The unique numeric identifier of the template to retrieve. You can get template IDs from the List Templates action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_LIST_SUBMISSIONSList document submissions with filtering and cursor-based pagination. Use to retrieve, search, and browse existing submissions by template, status, or submitter details. Supports searching by submitter name, email, or phone.

Input Parameters

string
Search query to filter submissions by submitter name, email, or phone (partial match).
string
Filter submissions by unique submission slug.
integer
Filter submissions with ID greater than this value (cursor-based pagination).
integer
Maximum number of submissions to return (default: 10, max: 100).
integer
Filter submissions with ID less than this value (cursor-based pagination).
string
Filter by submission status. Allowed values: ‘pending’, ‘completed’, ‘declined’, ‘expired’.
boolean
If true, returns archived submissions. If false, returns active submissions only.
integer
Filter submissions by a specific template ID.
string
Filter submissions by template folder name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_LIST_SUBMITTERSRetrieve a paginated list of submitters with optional filtering. Use this tool to: - List all submitters across all submissions - Filter submitters by submission, status dates, or search query - Paginate through large result sets using ‘after’ and ‘before’ cursors Examples: - List all submitters: {} - Filter by submission: {“submission_id”: 12345} - Search by email: {“q”: “john@example.com”} - Get completed submitters in a date range: {“completed_after”: “2024-01-01T00:00:00Z”, “completed_before”: “2024-12-31T23:59:59Z”} - Paginate results: {“limit”: 50, “after”: 3567000}

Input Parameters

string
Search query to filter submitters by name, email, or phone (partial match supported)
string
Filter by unique submitter slug (e.g., ‘zAyL9fH36Havvm’)
integer
Pagination cursor: return submitters with ID after this value. Use pagination.next from previous response.
integer
Number of results per page (default: 10, max: 100)
integer
Pagination cursor: return submitters with ID before this value
string
Filter by application-specific external identifier
integer
Filter submitters by a specific submission ID
string
Filter submitters who completed after this date/time (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’)
string
Filter submitters who completed before this date/time (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_LIST_TEMPLATES2Tool to retrieve a list of available document templates with pagination and filtering. Use when you need to search templates by name, slug, external_id, folder, or archived status.

Input Parameters

string
Filter templates based on the name partial match. Search for templates whose names contain this string.
string
Filter templates by unique slug identifier.
integer
Return templates with IDs greater than this value. Used for cursor-based pagination. Pass the ID from pagination.next to load the next batch.
integer
Maximum number of templates to return. Default is 10; maximum is 100.
integer
Return templates with IDs less than this value. Used for cursor-based pagination.
string
Filter templates by folder name.
boolean
If true, only archived templates are returned; if false or omitted, only active templates are returned.
string
The unique application-specific identifier provided for the template via API or Embedded template form builder. Filters templates with the specified external ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_MERGE_TEMPLATESMerge multiple DocuSeal templates into a single combined template. This action consolidates documents and fields from multiple source templates into one new template. Use this when you need to create a combined document package from existing templates. The merged template will contain all documents and fields from the source templates. Requires at least one template ID, but typically used with two or more.

Input Parameters

string
Name for the merged template. If not provided, a default name will be generated.
string
Your application-specific identifier for the merged template.
string
Name of the folder where the merged template will be stored.
array
required
List of template IDs (integers) to merge into a single template. At least two template IDs are required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_UPDATE_SUBMISSIONUpdate a submission’s name, expiration, or archived state.

Input Parameters

integer
required
The unique identifier of the submission to update.
string
New name for the submission.
boolean
Set true to archive the submission or false to unarchive it.
string
New expiration date and time. Pass null explicitly to remove the expiration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_UPDATE_SUBMITTERTool to update submitter details, pre-fill or update field values, re-send signature request emails, or mark as auto-signed for automatic signing via API. Use when you need to modify submitter information, resend requests, or programmatically complete submissions.

Input Parameters

integer
required
The unique identifier of the submitter to update
string
The name of the submitter
string
The email address of the submitter
string
The phone number of the submitter, formatted according to E.164 standard
array
A list of configurations for template document form fields (required, readonly, default values, validation)
object
An object with pre-filled values for the submission. Use field names as keys. For more configurations see fields param.
object
Custom email message configuration for signature request.
object
Metadata object with additional submitter information
string
Specify Reply-To address to use in the notification emails
boolean
Set true to re-send signature request via phone number SMS
boolean
Pass true to mark submitter as completed and auto-signed via API
boolean
Set true to re-send signature request emails
string
Your application-specific unique string key to identify this submitter within your app
boolean
Set to true to require phone 2FA verification via one-time code sent to phone number to access documents
string
Submitter specific URL to redirect to after the submission completion

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_UPDATE_TEMPLATE2Tool to update a document template by moving it to a different folder, changing its name, updating submitter roles, or unarchiving it. Use when you need to modify template properties.

Input Parameters

integer
required
The unique identifier of the document template.
string
The name of the template
array
An array of submitter role names to update the template with.
boolean
Set false to unarchive template.
string
The folder’s name to which the template should be moved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUSEAL_UPDATE_TEMPLATE_DOCUMENTSTool to add, remove, or replace documents in a template with provided PDF/DOCX file or HTML content. Use when you need to modify the document structure of an existing template.

Input Parameters

integer
required
The unique identifier of the template to update.
boolean
Set to true to merge all existing and new documents into a single PDF document in the template.
array
required
List of document updates to apply. Each item can add a new document, replace an existing one, or mark one for removal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not