/documenso-envelopes | Type: Application | PCID required: Yes
Tools
documenso_envelopes_envelope_attachment_create
Create attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_attachment_delete
Delete attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
documenso_envelopes_envelope_attachment_find
Find attachments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeId | string | Yes | — | Envelope Id |
token | string | No | — | The token value |
documenso_envelopes_envelope_attachment_update
Update attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
id | string | Yes | — | The id value |
documenso_envelopes_envelope_audit_log_find
Get envelope audit logs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeId | string | Yes | — | Envelope ID |
page | number | No | — | The pagination page number, starts at 1. |
perPage | number | No | — | The number of items per page. |
orderByColumn | string | No | — | Order By Column |
orderByDirection | string | No | — | Order By Direction |
documenso_envelopes_envelope_create
Create envelope Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
files | any[] | No | — | The files value |
payload | object | Yes | — | The payload value |
documenso_envelopes_envelope_delete
Delete envelope Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_distribute
Distribute envelope Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeId | string | Yes | — | Envelope Id |
meta | object | No | — | The meta value |
documenso_envelopes_envelope_duplicate
Duplicate envelope Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_field_create_many
Create envelope fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | any[] | Yes | — | The data value |
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_field_delete
Delete envelope field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | number | Yes | — | Field Id |
documenso_envelopes_envelope_field_get
Get envelope field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | number | Yes | — | Field Id |
documenso_envelopes_envelope_field_update_many
Update envelope fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | any[] | Yes | — | The data value |
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_find
Find envelopes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | The search query. |
page | number | No | — | The pagination page number, starts at 1. |
perPage | number | No | — | The number of items per page. |
type | string | No | — | Filter envelopes by type (DOCUMENT or TEMPLATE). |
templateId | number | No | — | Filter envelopes by the template ID used to create it. |
source | string | No | — | Filter envelopes by how it was created. |
status | string | No | — | Filter envelopes by the current status. |
folderId | string | No | — | Filter envelopes by folder ID. |
orderByColumn | string | No | — | Order By Column |
orderByDirection | string | No | — | Sort direction. |
documenso_envelopes_envelope_get
Get envelope Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_get_many
Get multiple envelopes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | object | Yes | — | Object with ‘type’ (envelopeId, documentId, or templateId) and ‘ids’ array |
documenso_envelopes_envelope_item_create_many
Create envelope items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
files | any[] | No | — | The files value |
payload | object | Yes | — | The payload value |
documenso_envelopes_envelope_item_delete
Delete envelope item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeId | string | Yes | — | Envelope Id |
envelopeItemId | string | Yes | — | Envelope Item Id |
documenso_envelopes_envelope_item_download
Download an envelope item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeItemId | string | Yes | — | The ID of the envelope item to download. |
version | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object[] | Yes | — | The data value |
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_recipient_create_many
Create envelope recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object[] | Yes | — | The data value |
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_recipient_delete
Delete envelope recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recipientId | number | Yes | — | Recipient Id |
documenso_envelopes_envelope_recipient_get
Get envelope recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recipientId | number | Yes | — | Recipient Id |
documenso_envelopes_envelope_recipient_update_many
Update envelope recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object[] | Yes | — | The data value |
envelopeId | string | Yes | — | Envelope Id |
documenso_envelopes_envelope_redistribute
Redistribute envelope Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
envelopeId | string | Yes | — | Envelope Id |
recipients | number[] | Yes | — | The recipients value |
documenso_envelopes_envelope_update
Update envelope Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | No | — | The data value |
envelopeId | string | Yes | — | Envelope Id |
meta | object | No | — | The meta value |
documenso_envelopes_envelope_use
Use envelope Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
files | any[] | No | — | The files value |
payload | object | Yes | — | The payload value |

