Documenso
documensoDocumenso is an open-source electronic signature platform that allows users to create, send, and sign documents digitally.
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ónTool to create a presign token for embedded authoring sessions. Use when initializing or renewing an embed session token.
DOCUMENSO_CREATE_EMBEDDING_PRESIGN_TOKEN_V2_BETAAcciónTool to create a presign token for embedded authoring sessions. Use when initializing or renewing an embed session token.
Parámetros de entrada
expiresInSecondsintegerCustom lifetime of the presign token in seconds. If omitted, defaults to 3600 (1 hour).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Document FieldsDOCUMENSO_DELETE_DOCUMENT_FIELDSAcciónTool 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.
DOCUMENSO_DELETE_DOCUMENT_FIELDSAcciónTool 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
fieldIdsintegerObligatorioSingle field ID (int) for individual deletion, or a list of field IDs for batch deletion.
documentIdintegerObligatorioIdentifier of the document containing the fields to delete
Parámetros de salida
dataobjectResponse data returned by the API on success
errorstringError if any occurred during the execution of the action
successbooleanTrue if the delete operation succeeded (2xx status code)
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Delete TemplateDOCUMENSO_DELETE_TEMPLATEAcciónTool to delete a template by ID.
DOCUMENSO_DELETE_TEMPLATEAcciónTool to delete a template by ID.
Parámetros de entrada
idintegerObligatorioID of the template to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Distribute Document V2DOCUMENSO_DISTRIBUTE_DOCUMENT_V2AcciónTool to distribute a document for signing. Use when you need to send a document to all or specific pending recipients.
DOCUMENSO_DISTRIBUTE_DOCUMENT_V2AcciónTool to distribute a document for signing. Use when you need to send a document to all or specific pending recipients.
Parámetros de entrada
documentIdintegerObligatorioNumeric ID of the document to distribute
recipientsinteger[]List of recipient IDs to target; omit to distribute to all pending recipients
Parámetros de salida
dataobjectResponse payload data
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Download Signed DocumentDOCUMENSO_DOWNLOAD_SIGNED_DOCUMENTAcciónTool to download a signed document file. Use when you need to retrieve the finalized PDF after a document has been signed.
DOCUMENSO_DOWNLOAD_SIGNED_DOCUMENTAcciónTool 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
idintegerObligatorioID of the signed document to download.
fileNamestringOptional override for the downloaded filename. If not provided, uses the Content-Disposition header or defaults to `document_{id}.pdf`.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Duplicate Document V2DOCUMENSO_DUPLICATE_DOCUMENT_V2AcciónTool 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.
DOCUMENSO_DUPLICATE_DOCUMENT_V2AcciónTool 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
documentIdintegerObligatorioNumeric ID of the document to duplicate
Parámetros de salida
dataobjectResponse payload data
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Find Documents V2DOCUMENSO_FIND_DOCUMENTS_V2AcciónTool to find documents. Use when retrieving a paginated list of documents for operations requiring a document ID.
DOCUMENSO_FIND_DOCUMENTS_V2AcciónTool to find documents. Use when retrieving a paginated list of documents for operations requiring a document ID.
Parámetros de entrada
pageintegerPage number for pagination (must be >= 1).
querystringSearch term to filter document titles or metadata.
statusstringFilter documents by status.
teamIdintegerFilter documents by team ID.
orderBystringField to sort results by.
perPageintegerNumber of documents per page (must be >= 1).
orderDirectionstringenumSort direction (asc or desc).
ascdesc
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TemplateDOCUMENSO_GET_TEMPLATEAcciónTool to fetch a template by ID.
DOCUMENSO_GET_TEMPLATEAcciónTool to fetch a template by ID.
Parámetros de entrada
idintegerObligatorioID of the template to fetch
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TemplatesDOCUMENSO_LIST_TEMPLATESAcciónTool to list templates. Use when fetching available templates with optional pagination.
DOCUMENSO_LIST_TEMPLATESAcciónTool to list templates. Use when fetching available templates with optional pagination.
Parámetros de entrada
pageintegerPage number for pagination (must be >= 1).
perPageintegerNumber of templates per page (must be >= 1).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Move Document V2DOCUMENSO_MOVE_DOCUMENT_V2AcciónTool to move a document to a team. Use when transferring documents between personal and team accounts.
DOCUMENSO_MOVE_DOCUMENT_V2AcciónTool to move a document to a team. Use when transferring documents between personal and team accounts.
Parámetros de entrada
teamIdstringObligatorioID of the target team to which the document will be moved
documentIdstringObligatorioID of the document to move
Parámetros de salida
dataobjectResponse payload data
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Redistribute Document V2DOCUMENSO_REDISTRIBUTE_DOCUMENT_V2AcciónTool 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.
DOCUMENSO_REDISTRIBUTE_DOCUMENT_V2AcciónTool 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
documentIdintegerObligatorioNumeric ID of the document to redistribute
recipientsinteger[]ObligatorioList of recipient IDs (numeric) to redistribute the document to.
Parámetros de salida
dataobjectPayload data returned by the API
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Remove Team Member V1DOCUMENSO_REMOVE_TEAM_MEMBER_V1AcciónTool to remove a member from a team.
DOCUMENSO_REMOVE_TEAM_MEMBER_V1AcciónTool to remove a member from a team.
Parámetros de entrada
team_idstringObligatorioID or slug of the team from which to remove the member
member_idstringObligatorioID of the member to remove from the team
Parámetros de salida
dataobjectRaw response payload if any
errorstringError if any occurred during the execution of the action
messagestringOptional message returned by the API
successbooleanIndicates whether removal was successful
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Resend Document For Signing V1DOCUMENSO_RESEND_DOCUMENT_FOR_SIGNING_V1AcciónTool to re-send a document for signing via POST /api/v1/documents/{id}/resend.
DOCUMENSO_RESEND_DOCUMENT_FOR_SIGNING_V1AcciónTool to re-send a document for signing via POST /api/v1/documents/{id}/resend.
Parámetros de entrada
idintegerObligatorioNumeric ID of the document to resend for signing
bodyobjectOptional request body. Send {} as required by the API even if no fields are needed.
Parámetros de salida
dataobjectRaw response payload if any
errorstringError if any occurred during the execution of the action
messagestringOptional message returned by the API
successbooleanIndicates whether the resend operation was successful
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Update Document FieldsDOCUMENSO_UPDATE_DOCUMENT_FIELDSAcciónTool to update one or more fields on a document. Use when you need to adjust properties of existing fields post-creation.
DOCUMENSO_UPDATE_DOCUMENT_FIELDSAcciónTool 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
updatesobjectObligatorioA single field update object. Must include the field `id`, and any other properties you wish to change.
documentIdintegerObligatorioIdentifier of the document to update fields on
Parámetros de salida
dataobjectResponse data returned by the API (typically updated field information as key-value pairs)
errorstringError if any occurred during the execution of the action
successbooleanWhether the update operation succeeded
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Update Document RecipientDOCUMENSO_UPDATE_DOCUMENT_RECIPIENTAcciónTool to update a document recipient. Use to change name, email, role, signing order or authentication options of a recipient.
DOCUMENSO_UPDATE_DOCUMENT_RECIPIENTAcciónTool to update a document recipient. Use to change name, email, role, signing order or authentication options of a recipient.
Parámetros de entrada
idintegerObligatorioIdentifier of the document
namestringRecipient's name
rolestringenumRecipient's role
SIGNERAPPROVERVIEWERASSISTANTCCemailstringRecipient's email address
authOptionsobjectOptions for recipient authentication (enterprise only).
recipientIdintegerObligatorioIdentifier of the recipient
signingOrderintegerOrder in which the recipient should sign (0-based index)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Document V2DOCUMENSO_UPDATE_DOCUMENT_V2AcciónTool to update document properties. Use after confirming the document ID is valid.
DOCUMENSO_UPDATE_DOCUMENT_V2AcciónTool to update document properties. Use after confirming the document ID is valid.
Parámetros de entrada
titlestringNew title for the document
teamIdintegerID of the team that owns the document
updatesobjectAdditional arbitrary metadata or options as a key-value map
folderIdintegerID of the folder to move the document into
documentIdintegerObligatorioNumeric ID of the document to update
externalIdstringExternal or business identifier for the document
visibilitystringVisibility setting of the document (e.g., 'private' or 'public')
Parámetros de salida
dataobjectResponse payload data on successful update
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by the API
Use Template (v2-beta)DOCUMENSO_USE_TEMPLATE_V2_BETAAcciónTool to create a document from a template. Use when you need to instantiate a template with recipients and optional prefills.
DOCUMENSO_USE_TEMPLATE_V2_BETAAcciónTool 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[]ObligatorioList of recipients to populate in the document
templateIdintegerObligatorioID of the template to use
prefillFieldsobject[]Optional field values to prefill into the document
Parámetros de salida
dataobjectObligatorioFull JSON response body returned by the API
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
status_codeintegerObligatorioHTTP status code returned by Documenso