Skip to main content
Server path: /documenso-envelopes | Type: Application | PCID required: Yes

Tools

ToolDescription
documenso_envelopes_envelope_attachment_createCreate attachment
documenso_envelopes_envelope_attachment_deleteDelete attachment
documenso_envelopes_envelope_attachment_findFind attachments
documenso_envelopes_envelope_attachment_updateUpdate attachment
documenso_envelopes_envelope_audit_log_findGet envelope audit logs
documenso_envelopes_envelope_createCreate envelope
documenso_envelopes_envelope_deleteDelete envelope
documenso_envelopes_envelope_distributeDistribute envelope
documenso_envelopes_envelope_duplicateDuplicate envelope
documenso_envelopes_envelope_field_create_manyCreate envelope fields
documenso_envelopes_envelope_field_deleteDelete envelope field
documenso_envelopes_envelope_field_getGet envelope field
documenso_envelopes_envelope_field_update_manyUpdate envelope fields
documenso_envelopes_envelope_findFind envelopes
documenso_envelopes_envelope_getGet envelope
documenso_envelopes_envelope_get_manyGet multiple envelopes
documenso_envelopes_envelope_item_create_manyCreate envelope items
documenso_envelopes_envelope_item_deleteDelete envelope item
documenso_envelopes_envelope_item_downloadDownload an envelope item
documenso_envelopes_envelope_item_update_manyUpdate envelope items
documenso_envelopes_envelope_recipient_create_manyCreate envelope recipients
documenso_envelopes_envelope_recipient_deleteDelete envelope recipient
documenso_envelopes_envelope_recipient_getGet envelope recipient
documenso_envelopes_envelope_recipient_update_manyUpdate envelope recipients
documenso_envelopes_envelope_redistributeRedistribute envelope
documenso_envelopes_envelope_updateUpdate envelope
documenso_envelopes_envelope_useUse envelope

documenso_envelopes_envelope_attachment_create

Create attachment Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_attachment_delete

Delete attachment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

documenso_envelopes_envelope_attachment_find

Find attachments Parameters:
ParameterTypeRequiredDefaultDescription
envelopeIdstringYesEnvelope Id
tokenstringNoThe token value

documenso_envelopes_envelope_attachment_update

Update attachment Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value
idstringYesThe id value

documenso_envelopes_envelope_audit_log_find

Get envelope audit logs Parameters:
ParameterTypeRequiredDefaultDescription
envelopeIdstringYesEnvelope ID
pagenumberNoThe pagination page number, starts at 1.
perPagenumberNoThe number of items per page.
orderByColumnstringNoOrder By Column
orderByDirectionstringNoOrder By Direction

documenso_envelopes_envelope_create

Create envelope Parameters:
ParameterTypeRequiredDefaultDescription
filesany[]NoThe files value
payloadobjectYesThe payload value

documenso_envelopes_envelope_delete

Delete envelope Parameters:
ParameterTypeRequiredDefaultDescription
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_distribute

Distribute envelope Parameters:
ParameterTypeRequiredDefaultDescription
envelopeIdstringYesEnvelope Id
metaobjectNoThe meta value

documenso_envelopes_envelope_duplicate

Duplicate envelope Parameters:
ParameterTypeRequiredDefaultDescription
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_field_create_many

Create envelope fields Parameters:
ParameterTypeRequiredDefaultDescription
dataany[]YesThe data value
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_field_delete

Delete envelope field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdnumberYesField Id

documenso_envelopes_envelope_field_get

Get envelope field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdnumberYesField Id

documenso_envelopes_envelope_field_update_many

Update envelope fields Parameters:
ParameterTypeRequiredDefaultDescription
dataany[]YesThe data value
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_find

Find envelopes Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoThe search query.
pagenumberNoThe pagination page number, starts at 1.
perPagenumberNoThe number of items per page.
typestringNoFilter envelopes by type (DOCUMENT or TEMPLATE).
templateIdnumberNoFilter envelopes by the template ID used to create it.
sourcestringNoFilter envelopes by how it was created.
statusstringNoFilter envelopes by the current status.
folderIdstringNoFilter envelopes by folder ID.
orderByColumnstringNoOrder By Column
orderByDirectionstringNoSort direction.

documenso_envelopes_envelope_get

Get envelope Parameters:
ParameterTypeRequiredDefaultDescription
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_get_many

Get multiple envelopes Parameters:
ParameterTypeRequiredDefaultDescription
idsobjectYesObject with ‘type’ (envelopeId, documentId, or templateId) and ‘ids’ array

documenso_envelopes_envelope_item_create_many

Create envelope items Parameters:
ParameterTypeRequiredDefaultDescription
filesany[]NoThe files value
payloadobjectYesThe payload value

documenso_envelopes_envelope_item_delete

Delete envelope item Parameters:
ParameterTypeRequiredDefaultDescription
envelopeIdstringYesEnvelope Id
envelopeItemIdstringYesEnvelope Item Id

documenso_envelopes_envelope_item_download

Download an envelope item Parameters:
ParameterTypeRequiredDefaultDescription
envelopeItemIdstringYesThe ID of the envelope item to download.
versionstringNoThe version of the envelope item to download. “signed” returns the completed document with signatures, “original” returns the original uploaded document.

documenso_envelopes_envelope_item_update_many

Update envelope items Parameters:
ParameterTypeRequiredDefaultDescription
dataobject[]YesThe data value
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_recipient_create_many

Create envelope recipients Parameters:
ParameterTypeRequiredDefaultDescription
dataobject[]YesThe data value
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_recipient_delete

Delete envelope recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientIdnumberYesRecipient Id

documenso_envelopes_envelope_recipient_get

Get envelope recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientIdnumberYesRecipient Id

documenso_envelopes_envelope_recipient_update_many

Update envelope recipients Parameters:
ParameterTypeRequiredDefaultDescription
dataobject[]YesThe data value
envelopeIdstringYesEnvelope Id

documenso_envelopes_envelope_redistribute

Redistribute envelope Parameters:
ParameterTypeRequiredDefaultDescription
envelopeIdstringYesEnvelope Id
recipientsnumber[]YesThe recipients value

documenso_envelopes_envelope_update

Update envelope Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectNoThe data value
envelopeIdstringYesEnvelope Id
metaobjectNoThe meta value

documenso_envelopes_envelope_use

Use envelope Parameters:
ParameterTypeRequiredDefaultDescription
filesany[]NoThe files value
payloadobjectYesThe payload value