Documenso

documenso

Documenso is an open-source electronic signature platform that allows users to create, send, and sign documents digitally.

Signatures Documents Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (17)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Embedding Presign Token V2 BetaDOCUMENSO_CREATE_EMBEDDING_PRESIGN_TOKEN_V2_BETAAcción

Tool to create a presign token for embedded authoring sessions. Use when initializing or renewing an embed session token.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Document FieldsDOCUMENSO_DELETE_DOCUMENT_FIELDSAcción

Tool to delete one or more fields from a document. Use when you have confirmed the field IDs to remove. Supports single-field and batch deletion.

Parámetros de entrada

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

Parámetros de salida

dataobject
Response data returned by the API on success
errorstring
Error if any occurred during the execution of the action
successboolean
True if the delete operation succeeded (2xx status code)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Delete TemplateDOCUMENSO_DELETE_TEMPLATEAcción

Tool to delete a template by ID.

Parámetros de entrada

idintegerObligatorio
ID of the template to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Distribute Document V2DOCUMENSO_DISTRIBUTE_DOCUMENT_V2Acción

Tool to distribute a document for signing. Use when you need to send a document to all or specific pending recipients.

Parámetros de entrada

documentIdintegerObligatorio
Numeric ID of the document to distribute
recipientsinteger[]
List of recipient IDs to target; omit to distribute to all pending recipients

Parámetros de salida

dataobject
Response payload data
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Download Signed DocumentDOCUMENSO_DOWNLOAD_SIGNED_DOCUMENTAcción

Tool to download a signed document file. Use when you need to retrieve the finalized PDF after a document has been signed.

Parámetros de entrada

idintegerObligatorio
ID of the signed document to download.
fileNamestring
Optional override for the downloaded filename. If not provided, uses the Content-Disposition header or defaults to `document_{id}.pdf`.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Duplicate Document V2DOCUMENSO_DUPLICATE_DOCUMENT_V2Acción

Tool 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.

Parámetros de entrada

documentIdintegerObligatorio
Numeric ID of the document to duplicate

Parámetros de salida

dataobject
Response payload data
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Find Documents V2DOCUMENSO_FIND_DOCUMENTS_V2Acción

Tool to find documents. Use when retrieving a paginated list of documents for operations requiring a document ID.

Parámetros de entrada

pageinteger
Page number for pagination (must be >= 1).
querystring
Search term to filter document titles or metadata.
statusstring
Filter documents by status.
teamIdinteger
Filter documents by team ID.
orderBystring
Field to sort results by.
perPageinteger
Number of documents per page (must be >= 1).
orderDirectionstringenum
Sort direction (asc or desc).
ascdesc

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TemplateDOCUMENSO_GET_TEMPLATEAcción

Tool to fetch a template by ID.

Parámetros de entrada

idintegerObligatorio
ID of the template to fetch

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TemplatesDOCUMENSO_LIST_TEMPLATESAcción

Tool to list templates. Use when fetching available templates with optional pagination.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Move Document V2DOCUMENSO_MOVE_DOCUMENT_V2Acción

Tool to move a document to a team. Use when transferring documents between personal and team accounts.

Parámetros de entrada

teamIdstringObligatorio
ID of the target team to which the document will be moved
documentIdstringObligatorio
ID of the document to move

Parámetros de salida

dataobject
Response payload data
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Redistribute Document V2DOCUMENSO_REDISTRIBUTE_DOCUMENT_V2Acción

Tool to redistribute a document to its pending recipients. Use when you need to re-send or re-distribute a sent document to recipients. Ensure the document has pending recipients or specific recipients selected before calling.

Parámetros de entrada

documentIdintegerObligatorio
Numeric ID of the document to redistribute
recipientsinteger[]Obligatorio
List of recipient IDs (numeric) to redistribute the document to.

Parámetros de salida

dataobject
Payload data returned by the API
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Remove Team Member V1DOCUMENSO_REMOVE_TEAM_MEMBER_V1Acción

Tool to remove a member from a team.

Parámetros de entrada

team_idstringObligatorio
ID or slug of the team from which to remove the member
member_idstringObligatorio
ID of the member to remove from the team

Parámetros de salida

dataobject
Raw response payload if any
errorstring
Error if any occurred during the execution of the action
messagestring
Optional message returned by the API
successboolean
Indicates whether removal was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Resend Document For Signing V1DOCUMENSO_RESEND_DOCUMENT_FOR_SIGNING_V1Acción

Tool to re-send a document for signing via POST /api/v1/documents/{id}/resend.

Parámetros de entrada

idintegerObligatorio
Numeric ID of the document to resend for signing
bodyobject
Optional request body. Send {} as required by the API even if no fields are needed.

Parámetros de salida

dataobject
Raw response payload if any
errorstring
Error if any occurred during the execution of the action
messagestring
Optional message returned by the API
successboolean
Indicates whether the resend operation was successful
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Update Document FieldsDOCUMENSO_UPDATE_DOCUMENT_FIELDSAcción

Tool to update one or more fields on a document. Use when you need to adjust properties of existing fields post-creation.

Parámetros de entrada

updatesobjectObligatorio
A single field update object. Must include the field `id`, and any other properties you wish to change.
documentIdintegerObligatorio
Identifier of the document to update fields on

Parámetros de salida

dataobject
Response data returned by the API (typically updated field information as key-value pairs)
errorstring
Error if any occurred during the execution of the action
successboolean
Whether the update operation succeeded
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Update Document RecipientDOCUMENSO_UPDATE_DOCUMENT_RECIPIENTAcción

Tool to update a document recipient. Use to change name, email, role, signing order or authentication options of a recipient.

Parámetros de entrada

idintegerObligatorio
Identifier of the document
namestring
Recipient's name
rolestringenum
Recipient's role
SIGNERAPPROVERVIEWERASSISTANTCC
emailstring
Recipient's email address
authOptionsobject
Options for recipient authentication (enterprise only).
recipientIdintegerObligatorio
Identifier of the recipient
signingOrderinteger
Order in which the recipient should sign (0-based index)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Document V2DOCUMENSO_UPDATE_DOCUMENT_V2Acción

Tool to update document properties. Use after confirming the document ID is valid.

Parámetros de entrada

titlestring
New title for the document
teamIdinteger
ID of the team that owns the document
updatesobject
Additional arbitrary metadata or options as a key-value map
folderIdinteger
ID of the folder to move the document into
documentIdintegerObligatorio
Numeric ID of the document to update
externalIdstring
External or business identifier for the document
visibilitystring
Visibility setting of the document (e.g., 'private' or 'public')

Parámetros de salida

dataobject
Response payload data on successful update
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by the API

Use Template (v2-beta)DOCUMENSO_USE_TEMPLATE_V2_BETAAcción

Tool to create a document from a template. Use when you need to instantiate a template with recipients and optional prefills.

Parámetros de entrada

recipientsobject[]Obligatorio
List of recipients to populate in the document
templateIdintegerObligatorio
ID of the template to use
prefillFieldsobject[]
Optional field values to prefill into the document

Parámetros de salida

dataobjectObligatorio
Full JSON response body returned by the API
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
status_codeintegerObligatorio
HTTP status code returned by Documenso