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

Tools

Slug: DOCUMENSO_CREATE_DOCUMENT_BETATool to create a new document using the beta endpoint that returns a presigned URL for file upload. After calling this action, upload the PDF file to the returned uploadUrl using a PUT request. Use when you need to create a document and upload the file separately.

Input Parameters

object
Metadata and settings for the document.
string
required
Title of the document
string
ID of the folder to place the document in
string
External identifier for the document (e.g., from your system)
object
Form field values for the document
array
Recipients for the document
string ("EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN")
Visibility setting for the document.
array
Attachments to include with the document
array
Global access authentication requirements
array
Global action authentication requirements

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: DOCUMENSO_CREATE_DOCUMENT_FIELDTool to create a single field for a document. Use when you need to add a signature, initials, text, or other field type to a specific location on a document page. The document must be in DRAFT status to add fields.

Input Parameters

object
required
Configuration for the field to create
integer
required
ID of the document to add the field to

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: DOCUMENSO_CREATE_DOCUMENT_FIELDS_BULKTool to create multiple fields on a document in a single operation. Use when you need to add signature fields, text fields, or other input fields to a DRAFT document. This bulk operation is more efficient than creating fields one at a time. All fields must reference valid recipient IDs from the document.

Input Parameters

array
required
List of field specifications to create. Each field must have all required position and dimension properties.
integer
required
Numeric ID of the document to add fields to. The document must be in DRAFT status.

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: DOCUMENSO_CREATE_DOCUMENT_RECIPIENTTool to create a single recipient for a document. Use when you need to add a new recipient (signer, viewer, approver, etc.) to an existing document.

Input Parameters

object
required
Recipient details including email, name, and role
integer
required
The numeric ID of the document to add recipient to. Use find_documents_v2 to get valid document IDs.

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: DOCUMENSO_CREATE_DOCUMENT_RECIPIENTS_BULKTool to create multiple recipients for a document at once. Use when you need to add multiple recipients (signers, approvers, viewers, etc.) to a document in a single operation. The document must be in DRAFT status before adding recipients.

Input Parameters

integer
required
The numeric ID of the document to add recipients to. The document must be in DRAFT status.
array
required
List of recipients to create for the document. Each recipient must have email, name, and role. You can specify 1 or more recipients.

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: DOCUMENSO_CREATE_EMBEDDING_PRESIGN_TOKEN_V2_BETACreate a presign token for Documenso embedded authoring sessions. Use this tool to generate a token that authorizes embedding document/template creation and editing interfaces in your application. The token is passed to Documenso embed components (EmbedCreateDocument, EmbedUpdateDocument, etc.). Note: This feature requires a Documenso Teams Plan or above. Returns 401 UNAUTHORIZED if the account lacks embedding permissions.

Input Parameters

integer
Custom lifetime of the presign token in seconds. If omitted, defaults to 3600 (1 hour).

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: DOCUMENSO_CREATE_ENVELOPETool to create a new envelope in Documenso. Use when you need to create a document or template envelope with optional file uploads, recipients, and configuration settings. The envelope can be configured with signing order, authentication requirements, and notification settings.

Input Parameters

object
Metadata configuration for the envelope.
string ("DOCUMENT" | "TEMPLATE")
required
Type of envelope: DOCUMENT (regular document) or TEMPLATE (reusable template)
array
List of files to upload as part of the envelope.
string
required
Title of the envelope (1-255 characters)
string
ID of the folder to place the envelope in
string
External or business identifier for the envelope (max 255 characters)
object
Form field values as a key-value dictionary
array
List of recipients who will receive or sign the envelope
string ("EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN")
Visibility setting: EVERYONE (all team members), MANAGER_AND_ABOVE (managers+), or ADMIN (admins only)
array
List of attachments to include with the envelope
array
Global access authentication requirements for viewing the envelope
array
Global action authentication requirements for signing the envelope
string
Email of the user who will own the document (must be a valid email format)

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: DOCUMENSO_CREATE_ENVELOPE_ATTACHMENTCreate a new attachment for an envelope in Documenso. Use this action to add supporting documents or files to an existing envelope. The file must be provided as a base64-encoded data URI in the format: data:<mime-type>;base64,<base64-data>.

Input Parameters

object
required
Attachment data containing label and base64-encoded file content.
string
required
ID of the envelope to attach the file to. Envelope IDs are strings with format ‘envelope_*’.

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: DOCUMENSO_CREATE_ENVELOPE_ITEMS_BULKTool to create multiple items for an envelope with optional file attachments. Use when you need to add items (documents) to an existing envelope in Documenso.

Input Parameters

array
Optional list of files to attach to the envelope.
string
required
The ID of the envelope to add items to (e.g., ‘envelope_amhzyhlrkbazwuiw’)

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: DOCUMENSO_CREATE_ENVELOPE_RECIPIENTS_BULKTool to create multiple recipients for an envelope in bulk. Use when you need to add several recipients to an existing envelope at once. Each recipient must have an email, name, and role (SIGNER, APPROVER, VIEWER, ASSISTANT, or CC).

Input Parameters

array
required
Array of recipient objects to create. Each recipient must have email, name, and role.
string
required
The envelope ID to add recipients to. Envelope must exist and be in a state that allows adding recipients.

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: DOCUMENSO_CREATE_FOLDERCreate a new folder in Documenso to organize documents or templates. Use this action when you need to create a folder for organizing files, either as a top-level folder or nested within an existing folder.

Input Parameters

string
required
Name of the folder to create
string ("DOCUMENT" | "TEMPLATE")
Folder type enumeration for organizing documents or templates.
string
Parent folder ID for creating nested folders. Leave empty to create a top-level folder.

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: DOCUMENSO_CREATE_TEMPLATE_BETATool to create a new template using the beta endpoint that returns a presigned URL for file upload. After calling this action, upload the PDF file to the returned uploadUrl using a PUT request. Use when you need to create a template and upload the file separately.

Input Parameters

object
Metadata and settings for the template.
string ("PUBLIC" | "PRIVATE")
Type of template (public or private).
string
required
Title of the template
string
ID of the folder to place the template in
string
External identifier for the template (e.g., from your system)
string ("EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN")
Visibility setting for the template.
array
Attachments to include with the template
string
Public title for the template (for public templates)
array
Global access authentication requirements
array
Global action authentication requirements
string
Public description for the template (for public templates)

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: DOCUMENSO_CREATE_TEMPLATE_FIELDTool to create a single field for a template. Use when you need to add a signature, initials, text, or other field type to a specific location on a template page.

Input Parameters

object
required
Configuration for the field to create
integer
required
ID of the template to add the field to

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: DOCUMENSO_CREATE_TEMPLATE_FIELDS_BULKTool to create multiple fields on a template in a single operation. Use when you need to add signature fields, text fields, or other input fields to a template. This bulk operation is more efficient than creating fields one at a time. All fields must reference valid recipient IDs from the template.

Input Parameters

array
required
List of field specifications to create. Each field must have all required position and dimension properties.
integer
required
Numeric ID of the template to add fields to. The template must exist and be accessible.

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: DOCUMENSO_CREATE_TEMPLATE_RECIPIENTTool to create a single recipient for a template. Use when you need to add a new recipient (signer, viewer, approver, etc.) to an existing template.

Input Parameters

object
required
Recipient details including email, name, and role
integer
required
The numeric ID of the template to add recipient to. Use find_templates or list_templates to get valid template IDs.

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: DOCUMENSO_CREATE_TEMPLATE_RECIPIENTS_BULKTool to create multiple recipients for a template at once. Use when you need to add multiple recipients (signers, approvers, viewers, etc.) to a template in a single operation.

Input Parameters

array
required
List of recipients to create for the template. Each recipient must have email, name, and role. You can specify 1 or more recipients.
integer
required
The numeric ID of the template to add recipients to. The template must exist and be in a valid state.

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: DOCUMENSO_DELETE_DOCUMENTTool to delete a document. Use when you need to permanently remove a document from Documenso. The deletion is irreversible.

Input Parameters

integer
required
Numeric ID of the document to delete. Use find_documents_v2 to get valid document IDs.

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: DOCUMENSO_DELETE_DOCUMENT_ATTACHMENTTool to delete an attachment from a document. Use when you need to remove a previously uploaded attachment from a document. The deletion is permanent.

Input Parameters

string
required
The unique identifier of the attachment to delete. This ID is returned when attachments are created or listed.

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: DOCUMENSO_DELETE_DOCUMENT_FIELDTool to delete a single document field by ID. Use when you need to remove a specific field from a document.

Input Parameters

integer
required
Numeric ID of the document field to delete. Obtain this from document details or field creation response.

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: DOCUMENSO_DELETE_DOCUMENT_FIELDSDelete one or more fields from a document by field ID. Each field is deleted separately, so a batch can partially succeed; the result reports successful and failed deletions.

Input Parameters

string
required
Single field ID (int) for individual deletion, or a list of field IDs for batch deletion.
string
required
Identifier of the document containing the fields to delete

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: DOCUMENSO_DELETE_DOCUMENT_RECIPIENTTool to delete a recipient from a document. Use when you need to remove a recipient from a document’s signing workflow.

Input Parameters

string
required
The unique numeric ID of the recipient to delete from the document

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: DOCUMENSO_DELETE_ENVELOPETool to permanently delete an envelope. Use when you need to remove an envelope from Documenso. The deletion is irreversible and will remove all associated data.

Input Parameters

string
required
The unique identifier of the envelope to delete. This is the envelope’s ID string (e.g., ‘envelope_cawirirwaumiabbi’). Deletion is permanent and cannot be undone.

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: DOCUMENSO_DELETE_ENVELOPE_ATTACHMENTTool to delete an attachment from an envelope. Use when you need to remove a file attachment from a Documenso envelope.

Input Parameters

string
required
The unique identifier of the envelope attachment to delete. This ID is returned when listing envelope attachments or creating an attachment.

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: DOCUMENSO_DELETE_ENVELOPE_FIELDTool to delete a field from an envelope. Use when you need to remove an existing field from a document envelope.

Input Parameters

integer
required
Numeric ID of the envelope field to delete. Obtain this from envelope details or field creation.

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: DOCUMENSO_DELETE_ENVELOPE_ITEMTool to delete an item from an envelope. Use when you need to remove an existing item from a document envelope.

Input Parameters

string
required
Unique identifier of the envelope containing the item to delete. Obtain this from envelope details or creation.
string
required
Unique identifier of the envelope item to delete. Obtain this from envelope item details or creation.

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: DOCUMENSO_DELETE_ENVELOPE_RECIPIENTTool to delete a recipient from an envelope. Use when you need to remove a recipient from an envelope’s signing workflow.

Input Parameters

integer
required
The unique numeric ID of the recipient to delete from the envelope

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: DOCUMENSO_DELETE_FOLDERTool to permanently delete a folder. Use when you need to remove a folder from Documenso. The deletion is irreversible and will remove all associated data.

Input Parameters

string
required
The unique identifier of the folder to delete. This is the folder’s ID string. Deletion is permanent and cannot be undone.

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: DOCUMENSO_DELETE_TEMPLATEPermanently delete a template by its ID. The result includes the HTTP status and a success flag, with a message or error when supplied by the API.

Input Parameters

integer
required
The unique numeric ID of the template to delete. You can obtain template IDs by listing templates using 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: DOCUMENSO_DELETE_TEMPLATE_RECIPIENTTool to delete a recipient from a template. Use when you need to remove a recipient from a template’s configuration.

Input Parameters

string
required
The unique numeric ID of the recipient to delete from the 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: DOCUMENSO_DELETE_TEMPLATE_V2Tool to permanently delete a template using the v2 API. Use when you need to remove a template from Documenso. The deletion is irreversible.

Input Parameters

integer
required
The unique numeric ID of the template to delete. You can obtain template IDs by listing templates.

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: DOCUMENSO_DISTRIBUTE_DOCUMENT_V2Tool to distribute a document for signing. Use when you need to send a DRAFT document to recipients for the first time. The document must have recipients with signature fields configured before distribution. For re-sending to recipients who already received the document, use Redistribute Document instead.

Input Parameters

integer
required
The numeric ID of the document to distribute. Use Find Documents to get this ID. The document must be in DRAFT status with recipients and signature fields configured.
array
Optional list of specific recipient IDs to distribute to. If omitted, the document is distributed to all pending recipients. Recipient IDs can be obtained from document details.

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: DOCUMENSO_DISTRIBUTE_ENVELOPETool to distribute an envelope to recipients for signing. Use when you need to send an envelope to recipients for the first time. The envelope must have recipients with required signature fields configured before distribution. Returns success status of the distribution operation.

Input Parameters

object
Optional metadata for envelope distribution configuration.
string
required
The ID of the envelope to distribute. The envelope must have recipients configured before distribution. Use the format ‘envelope_xxxxx’.

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: DOCUMENSO_DOWNLOAD_ENVELOPE_ITEMDownload the original or signed version of a document within an envelope as a file. The returned file may contain an API error payload rather than a PDF when the download fails.

Input Parameters

string ("original" | "signed")
Version of the envelope item to download.
string
Optional override for the downloaded filename. If not provided, uses the Content-Disposition header or defaults to envelope_item_{envelopeItemId}.pdf.
string
required
The ID of the envelope item to download. Format: envelope_item_<id>. Use DOCUMENSO_GET_ENVELOPE_BY_ID to retrieve envelope items from an envelope.

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: DOCUMENSO_DOWNLOAD_SIGNED_DOCUMENTDownload a completed or signed document as a PDF. The returned file may contain an API error payload rather than a PDF, including when the document is not completed.

Input Parameters

integer
required
Numeric ID of the document to download. Use DOCUMENSO_FIND_DOCUMENTS_V2 to get valid document IDs. Note: The download will only succeed for documents with COMPLETED status; attempting to download non-completed documents returns an error payload.
string
Optional override for the downloaded filename. If not provided, uses the Content-Disposition header or defaults to document_{id}.pdf.

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: DOCUMENSO_DUPLICATE_DOCUMENT_V2Tool to duplicate a document. Use when you need to create an exact copy of an existing document. Ensure the source document ID is valid before calling.

Input Parameters

integer
required
Numeric ID of the document to duplicate

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: DOCUMENSO_DUPLICATE_ENVELOPE_V2Tool to duplicate an envelope with all its settings. Use when you need to create an exact copy of an existing envelope including recipients, fields, and configuration.

Input Parameters

string
required
The ID of the envelope to duplicate. The duplicated envelope will inherit all settings from the original.

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: DOCUMENSO_DUPLICATE_TEMPLATETool to duplicate a template with all its settings. Use when you need to create an exact copy of an existing template including fields, recipients, and configuration.

Input Parameters

integer
required
The ID of the template to duplicate. The duplicated template will inherit all settings from the original.

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: DOCUMENSO_FIND_DOCUMENTSFind documents based on search criteria with filtering and pagination. Use when searching for documents by title, status, template, folder, or source. Supports pagination for retrieving large result sets efficiently.

Input Parameters

integer
The pagination page number, starts at 1.
string
Search query to filter documents by title or content.
string ("DOCUMENT" | "TEMPLATE" | "TEMPLATE_DIRECT_LINK")
Source of the document.
string ("DRAFT" | "PENDING" | "COMPLETED" | "REJECTED")
Status of the document.
integer
The number of items per page.
string
Filter documents by folder ID. Use to get documents in a specific folder.
integer
Filter documents by the template ID used to create it.
string ("createdAt")
Column to order by.
string ("asc" | "desc")
Order direction.

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: DOCUMENSO_FIND_DOCUMENTS_V2Retrieve a paginated list of documents with optional filtering and sorting. Use this action to list documents, search by title, or filter by status (DRAFT, PENDING, COMPLETED). Commonly used to obtain document IDs for subsequent operations like downloading, updating, or deleting documents.

Input Parameters

integer
Page number for pagination, starting at 1. Defaults to 1 if not specified.
string
Search term to filter documents by title.
string ("DRAFT" | "PENDING" | "COMPLETED")
Filter documents by status. Valid values: DRAFT (newly created), PENDING (sent for signing), COMPLETED (fully signed).
integer
Filter documents by team ID. Only returns documents belonging to the specified team.
string ("createdAt" | "updatedAt" | "title")
Field to sort results by. Common values: createdAt, updatedAt, title.
integer
Number of documents per page. Defaults to server-side limit if not specified.
string ("asc" | "desc")
Sort direction. ‘asc’ for ascending (oldest first), ‘desc’ for descending (newest first). Defaults to ‘desc’.

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: DOCUMENSO_FIND_ENVELOPESTool to find envelopes based on search criteria, filters, and pagination. Use this action to search and filter envelopes by query, type, status, source, template ID, or folder ID. Commonly used to retrieve envelope lists for management, reporting, or subsequent operations.

Input Parameters

integer
Page number for pagination, starting at 1. Defaults to 1 if not specified.
string ("DOCUMENT" | "TEMPLATE")
Envelope type filter values.
string
Search query to filter envelopes.
string ("DOCUMENT" | "TEMPLATE" | "TEMPLATE_DIRECT_LINK")
Envelope source filter values.
string ("DRAFT" | "PENDING" | "COMPLETED" | "REJECTED")
Envelope status filter values.
integer
Number of envelopes per page. Defaults to server-side limit if not specified.
string
Filter envelopes by folder ID.
integer
Filter envelopes by the template ID used to create it.
string ("createdAt")
Column to order results by.
string ("asc" | "desc")
Sort direction for results.

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: DOCUMENSO_FIND_FOLDERSTool to find folders based on search criteria and filters. Use this action to search folders by name, filter by type (DOCUMENT or TEMPLATE), or retrieve subfolders by parent ID. Commonly used to organize documents/templates or retrieve folder IDs for subsequent operations.

Input Parameters

integer
Page number for pagination, starting at 1. Defaults to 1 if not specified.
string ("DOCUMENT" | "TEMPLATE")
Folder type filter values.
string
Search query to filter folders by name.
integer
Number of folders per page. Defaults to server-side limit if not specified.
string
Filter folders by parent folder ID. Use to retrieve subfolders of a specific parent.

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: DOCUMENSO_FIND_TEMPLATESRetrieve a paginated list of templates with optional filtering and search. Use this action to find templates, search by title/content, or filter by type (PUBLIC, PRIVATE) or folder. Commonly used to obtain template IDs for subsequent operations like using, updating, or deleting templates.

Input Parameters

integer
Page number for pagination, starting at 1. Defaults to 1 if not specified.
string ("PUBLIC" | "PRIVATE")
Template visibility type.
string
Search term to filter templates by title or content.
integer
Number of templates per page. Defaults to server-side limit if not specified.
string
The ID of the folder to filter templates by. Only returns templates in the specified folder.

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: DOCUMENSO_GET_DOCUMENT_BY_IDRetrieve complete information about a document by its ID. Returns full document details including metadata, recipients, fields, and signing status. Use find_documents_v2 first to get valid document IDs.

Input Parameters

integer
required
Numeric ID of the document to fetch. Use find_documents_v2 to get valid document IDs.

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: DOCUMENSO_GET_DOCUMENT_FIELDTool to retrieve a document field by its ID. Use when you need to fetch details about a specific field including its type, position, recipient assignment, and metadata. Useful for inspecting field properties before updating or for validating field configurations.

Input Parameters

integer
required
Numeric ID of the document field to retrieve

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: DOCUMENSO_GET_DOCUMENT_RECIPIENTTool to retrieve detailed information about a document recipient by their ID. Use when you need to check the status, fields, or other details of a specific recipient.

Input Parameters

integer
required
The unique numeric ID of the recipient to retrieve

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: DOCUMENSO_GET_DOCUMENTS_BY_IDSRetrieve multiple documents by their IDs in a single request. Use when you need to fetch detailed information for specific documents. This is more efficient than calling individual get document endpoints when retrieving multiple documents.

Input Parameters

array
required
List of document IDs to retrieve. Must contain at least one document ID. Use Find Documents V2 to discover document IDs.

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: DOCUMENSO_GET_ENVELOPE_ATTACHMENTTool to find all attachments for a specific envelope. Use this when you need to retrieve attachment information including IDs, types, labels, and data for all attachments associated with an envelope.

Input Parameters

string
Optional token for authentication or authorization. Use this if additional token-based access is required.
string
required
ID of the envelope to retrieve attachments for. This is the unique identifier of the envelope containing attachments.

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: DOCUMENSO_GET_ENVELOPE_AUDIT_LOGRetrieve a page of audit log entries for an envelope, with pagination and sorting options. Entries include timestamps and may include user and access details.

Input Parameters

integer
The pagination page number, starts at 1. Defaults to 1 if not specified.
integer
The number of items per page. Defaults to server-side limit if not specified.
string
required
The ID of the envelope to retrieve audit logs for. Use actions like FIND_ENVELOPES or CREATE_ENVELOPE to get valid envelope IDs.
string ("createdAt")
Enum for orderByColumn parameter.
string ("asc" | "desc")
Enum for orderByDirection parameter.

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: DOCUMENSO_GET_ENVELOPE_BY_IDRetrieve complete information about an envelope by its ID. Returns full envelope details including metadata, recipients, fields, and signing status. Use find_envelopes first to get valid envelope IDs.

Input Parameters

string
required
Unique identifier of the envelope to retrieve. Use find_envelopes to get valid envelope IDs.

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: DOCUMENSO_GET_ENVELOPE_FIELDTool to fetch an envelope field by ID. Use this to retrieve detailed information about a specific field in an envelope, including its type, position, dimensions, and metadata configuration.

Input Parameters

integer
required
ID of the envelope field to retrieve. This is the unique identifier of the field within the envelope.

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: DOCUMENSO_GET_ENVELOPE_RECIPIENTTool to retrieve detailed information about an envelope recipient by their ID. Use when you need to check the status, fields, or other details of a specific recipient.

Input Parameters

integer
required
The unique numeric ID of the recipient to retrieve

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: DOCUMENSO_GET_ENVELOPES_BY_IDSTool to retrieve multiple envelopes by their IDs. Use this action when you need to fetch multiple envelopes in a single request using envelope IDs, document IDs, or template IDs. Specify the ID type and provide an array of IDs to retrieve.

Input Parameters

object
required
Object containing the type discriminator and array of IDs to retrieve.

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: DOCUMENSO_GET_TEMPLATE_BY_IDRetrieve complete information about a template by its ID. Returns full template details including metadata, recipients, fields, and configuration settings. Use find_templates or list_templates first to get valid template IDs.

Input Parameters

integer
required
Numeric ID of the template to fetch. Use find_templates or list_templates to get valid template IDs.

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: DOCUMENSO_GET_TEMPLATE_FIELDTool to fetch a template field by ID. Use this to retrieve detailed information about a specific field in a template, including its type, position, dimensions, and metadata configuration.

Input Parameters

integer
required
ID of the template field to retrieve. This is the unique identifier of the field within the 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: DOCUMENSO_GET_TEMPLATE_RECIPIENTTool to retrieve detailed information about a template recipient by their ID. Use when you need to check the status, fields, or other details of a specific template recipient.

Input Parameters

integer
required
The unique numeric ID of the recipient to retrieve

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: DOCUMENSO_GET_TEMPLATES_BY_IDSRetrieve multiple templates by their IDs in a single request. Use when you need to fetch detailed information for specific templates. This is more efficient than calling individual get template endpoints when retrieving multiple templates.

Input Parameters

array
required
List of template IDs to retrieve. Must contain at least one template ID. Use Find Templates to discover template IDs.

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: DOCUMENSO_LIST_TEMPLATESTool to list templates. Use when fetching available templates with optional pagination.

Input Parameters

integer
Page number for pagination (must be >= 1).
integer
Number of templates per page (must be >= 1).

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: DOCUMENSO_MOVE_DOCUMENT_V2Tool to move a document to a team. Use when transferring documents between personal and team accounts.

Input Parameters

integer
Numeric ID of the target team to move the document to. Pass null/None to move to personal account. Obtain team IDs from team-related actions.
integer
required
Numeric ID of the document to move. Obtain this from the find_documents or get_document actions.

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: DOCUMENSO_REDISTRIBUTE_DOCUMENT_V2Re-send signing request emails to specified recipients of a document. Use this when recipients haven’t received or lost their signing emails, or when you need to remind them to sign. The document must be in PENDING status and the recipients must belong to the document.

Input Parameters

integer
required
The numeric ID of the document to redistribute. Use Find Documents to get this ID.
array
required
List of recipient IDs to redistribute the document to. Recipients must belong to the document. Use the document details endpoint or get recipients from document data to obtain these IDs.

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: DOCUMENSO_REDISTRIBUTE_ENVELOPETool to redistribute an envelope to recipients who have not actioned it. Use when recipients haven’t received or lost their signing emails, or when you need to remind them to sign. The envelope must be in PENDING status and the recipients must belong to the envelope and not have already completed their action.

Input Parameters

string
required
The ID of the envelope to redistribute. Use the format ‘envelope_xxxxx’.
array
required
List of recipient IDs to redistribute the envelope to. Recipients must belong to the envelope and have not yet actioned it. Minimum 1 recipient 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: DOCUMENSO_REMOVE_TEAM_MEMBER_V1Remove a member from a Documenso team. This action removes an existing member from the specified team. The caller must have appropriate permissions (typically team owner or manager) to remove members. Note: The team_id can be obtained from documents that belong to a team (teamId field in document responses). The member_id should be obtained by listing team members first.

Input Parameters

integer
required
The numeric ID of the team from which to remove the member. Can be obtained from documents that belong to the team (teamId field).
integer
required
The numeric ID of the team member to remove. This is the member’s ID within the team context, not the user 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: DOCUMENSO_UPDATE_DOCUMENT_ATTACHMENTTool to update an existing document attachment. Use when you need to change the label or file URL of an attachment. Requires the attachment ID and updated data (label and URL).

Input Parameters

string
required
Unique identifier of the attachment to update. Use document endpoints to retrieve attachment IDs.
object
required
Updated attachment data including label and file URL

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: DOCUMENSO_UPDATE_DOCUMENT_FIELDTool to update a single document field’s properties in Documenso v2 API. Use when you need to modify position, size, or type of an existing field. The field type must always be provided even when updating other properties.

Input Parameters

object
required
Field data with ID and properties to update
integer
required
ID of the document containing the field to update

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: DOCUMENSO_UPDATE_DOCUMENT_FIELDS_BULKTool to update multiple document fields in a single operation. Use when you need to modify properties (position, size, type) of multiple fields at once. This is more efficient than updating fields individually. The document must be in DRAFT status - fields on documents that have been sent for signing cannot be updated.

Input Parameters

array
required
Array of field updates. Each field must include id and type. Position and size properties are optional.
integer
required
Numeric ID of the document containing the fields to update

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: DOCUMENSO_UPDATE_DOCUMENT_RECIPIENT_V2Tool to update a document recipient using the v2 API. Use to change recipient name, email, role, signing order, or authentication options for a specific document recipient.

Input Parameters

object
required
Recipient data to update. Must include recipient ID and at least one field to update.
integer
required
Numeric ID of the document containing the recipient

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: DOCUMENSO_UPDATE_DOCUMENT_V2Update document properties like title, visibility, and signing settings. Use find_documents_v2 first to get a valid document ID. Only DRAFT documents can have all properties updated; PENDING documents have limited updates.

Input Parameters

string
New title for the document (1-255 characters)
string
Email message body for document notifications (max 5000 characters)
string
Email subject for document notifications (max 254 characters)
string
ID of the folder to move the document into. Set to null to remove from folder.
string ("de" | "en" | "fr" | "es" | "it" | "nl" | "pl" | "pt-BR" | "ja" | "ko" | "zh")
Language for the signing interface
string
Timezone for date formatting (e.g., ‘America/New_York’, ‘Europe/London’)
string
Date format for timestamps. Options include: yyyy-MM-dd, dd/MM/yyyy, MM/dd/yyyy, MMMM dd, yyyy, etc.
integer
required
Numeric ID of the document to update. Use find_documents_v2 to get valid document IDs.
string
External or business identifier for the document (max 255 characters). Set to null to clear.
string ("EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN")
Visibility setting: EVERYONE (all team members), MANAGER_AND_ABOVE (managers+), or ADMIN (admins only)
string
URL to redirect signers after completing signing
string ("PARALLEL" | "SEQUENTIAL")
Signing order: PARALLEL (all at once) or SEQUENTIAL (one after another)
array
Global access authentication requirements for viewing the document
array
Global action authentication requirements for signing the document
string ("EMAIL" | "NONE")
How to distribute the document: EMAIL (send via email) or NONE (manual distribution)
boolean
Allow signers to draw their signature
boolean
Allow signers to type their signature
boolean
Allow signers to upload an image of their signature
boolean
Whether to use legacy field insertion mode

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: DOCUMENSO_UPDATE_ENVELOPEUpdate envelope properties like title, visibility, and signing settings. Use find_envelopes first to get a valid envelope ID. Only DRAFT envelopes can have all properties updated; PENDING envelopes have limited updates.

Input Parameters

string
New title for the envelope (1-255 characters)
string
Email template ID to use for notifications
string
Email message body for envelope notifications (max 5000 characters)
string
Email subject for envelope notifications (max 254 characters)
string
ID of the folder to move the envelope into. Set to null to remove from folder.
string ("de" | "en" | "fr" | "es" | "it" | "nl" | "pl" | "pt-BR" | "ja" | "ko" | "zh")
Language options for envelope interface.
string
Timezone for date formatting (e.g., ‘America/New_York’, ‘Europe/London’)
string ("yyyy-MM-dd hh:mm a" | "yyyy-MM-dd" | "dd/MM/yyyy" | "MM/dd/yyyy" | "yy-MM-dd" | "MMMM dd, yyyy" | "EEEE, MMMM dd, yyyy" | "dd/MM/yyyy hh:mm a" | "dd/MM/yyyy HH:mm" | "MM/dd/yyyy hh:mm a" | "MM/dd/yyyy HH:mm" | "dd.MM.yyyy" | "dd.MM.yyyy HH:mm" | "yyyy-MM-dd HH:mm" | "yy-MM-dd hh:mm a" | "yy-MM-dd HH:mm" | "yyyy-MM-dd HH:mm:ss" | "MMMM dd, yyyy hh:mm a" | "MMMM dd, yyyy HH:mm" | "EEEE, MMMM dd, yyyy hh:mm a" | "EEEE, MMMM dd, yyyy HH:mm" | "yyyy-MM-dd'T'HH:mm:ss.SSSXXX")
Date format options for envelopes.
string
required
The unique identifier of the envelope to update (e.g., ‘envelope_sthyytwdaturthin’). Use find_envelopes to get valid envelope IDs.
string
External or business identifier for the envelope (max 255 characters). Set to null to clear.
string ("EVERYONE" | "MANAGER_AND_ABOVE" | "ADMIN")
Visibility options for envelopes.
string
URL to redirect signers after completing signing
string
Reply-to email address for envelope notifications (must be valid email format)
string ("PARALLEL" | "SEQUENTIAL")
Signing order options for envelopes.
object
Email notification settings for envelope events.
array
Global access authentication requirements for viewing the envelope (e.g., [‘ACCOUNT’, ‘TWO_FACTOR_AUTH’])
array
Global action authentication requirements for signing the envelope (e.g., [‘ACCOUNT’, ‘PASSKEY’, ‘TWO_FACTOR_AUTH’, ‘PASSWORD’])
string ("EMAIL" | "NONE")
Distribution method for envelopes.
boolean
Allow signers to draw their signature
boolean
Allow signers to type their signature
boolean
Allow signers to dictate who signs next in sequential signing
boolean
Allow signers to upload an image of their signature

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: DOCUMENSO_UPDATE_ENVELOPE_ATTACHMENTTool to update an existing envelope attachment. Use when you need to modify the label or content of an attachment that was previously added to an envelope. The attachment data must be provided in base64-encoded data URI format.

Input Parameters

string
required
Unique identifier of the envelope attachment to update. Obtain this from the envelope details or attachment creation response.
object
required
Updated attachment data containing the label and base64-encoded content

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: DOCUMENSO_UPDATE_ENVELOPE_FIELDS_BULKTool to update multiple envelope fields in a single request. Use when you need to modify properties of multiple existing fields (position, size, type) efficiently. All position and dimension values must be between 0 and 100. The type field is required for all updates, even when only changing position or dimensions.

Input Parameters

array
required
Array of field updates. Each object must contain the field ID and type, along with optional position and dimension properties.
string
required
ID of the envelope containing the fields to update.

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: DOCUMENSO_UPDATE_ENVELOPE_ITEMS_BULKTool to update multiple envelope items in a single request. Use when you need to modify the title or order of multiple envelope items belonging to the same envelope. This is more efficient than updating items individually when making bulk changes.

Input Parameters

array
required
List of envelope items to update. Each item must include envelopeItemId and at least one field to update (title or order).
string
required
The unique identifier of the envelope containing the items to update

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: DOCUMENSO_UPDATE_FOLDERUpdate properties of an existing folder including name, pinned status, parent folder, and visibility. Use this action to reorganize folder structure or modify folder settings.

Input Parameters

object
required
Object containing the folder properties to update. Only provided fields will be updated.
string
required
Unique identifier of the folder to update. Use this to specify which folder to modify.

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: DOCUMENSO_UPDATE_TEMPLATEUpdate template properties like title, visibility, and signing settings. Use list_templates or find_templates first to get a valid template ID.

Input Parameters

object
Template data properties that can be updated.
object
Metadata settings for template signing and distribution.
integer
required
Numeric ID of the template to update. Use list_templates or find_templates to get valid template IDs.

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: DOCUMENSO_UPDATE_TEMPLATE_FIELDS_BULKTool to update multiple template fields in a single operation. Use when you need to modify properties (position, size, type) of multiple fields at once on a template. This is more efficient than updating fields individually.

Input Parameters

array
required
Array of field updates. Each field must include id and type. Position and size properties are optional.
integer
required
Numeric ID of the template containing the fields to update

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: DOCUMENSO_UPDATE_TEMPLATE_RECIPIENTTool to update a template recipient. Use to change recipient name, email, role, signing order, or authentication options for a specific template recipient.

Input Parameters

object
required
Recipient data to update. Must include recipient ID and at least one field to update.
integer
required
Numeric ID of the template containing the recipient

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: DOCUMENSO_UPDATE_TEMPLATE_RECIPIENTS_BULKTool to update multiple template recipients in a single API call. Use when you need to change properties (name, email, role, signing order, authentication) for multiple recipients on the same template efficiently.

Input Parameters

array
required
List of template recipients to update. Each recipient must include an ‘id’ field and at least one field to update (name, email, role, etc.)
integer
required
The numeric ID of the template containing the recipients to update

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: DOCUMENSO_USE_TEMPLATE_V2_BETACreate a document from a template with recipients and optional prefilled fields. The response includes the HTTP status and places API error responses in an error field.

Input Parameters

array
required
List of recipients to populate in the document
integer
required
ID of the template to use
array
Optional field values to prefill into the document

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