> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# documenso-envelopes

> Documenso Envelopes - manage envelopes, attachments, fields, items, and recipients

**Server path:** `/documenso-envelopes` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                        | Description                |
| ----------------------------------------------------------------------------------------------------------- | -------------------------- |
| [`documenso_envelopes_envelope_attachment_create`](#documenso_envelopes_envelope_attachment_create)         | Create attachment          |
| [`documenso_envelopes_envelope_attachment_delete`](#documenso_envelopes_envelope_attachment_delete)         | Delete attachment          |
| [`documenso_envelopes_envelope_attachment_find`](#documenso_envelopes_envelope_attachment_find)             | Find attachments           |
| [`documenso_envelopes_envelope_attachment_update`](#documenso_envelopes_envelope_attachment_update)         | Update attachment          |
| [`documenso_envelopes_envelope_audit_log_find`](#documenso_envelopes_envelope_audit_log_find)               | Get envelope audit logs    |
| [`documenso_envelopes_envelope_create`](#documenso_envelopes_envelope_create)                               | Create envelope            |
| [`documenso_envelopes_envelope_delete`](#documenso_envelopes_envelope_delete)                               | Delete envelope            |
| [`documenso_envelopes_envelope_distribute`](#documenso_envelopes_envelope_distribute)                       | Distribute envelope        |
| [`documenso_envelopes_envelope_duplicate`](#documenso_envelopes_envelope_duplicate)                         | Duplicate envelope         |
| [`documenso_envelopes_envelope_field_create_many`](#documenso_envelopes_envelope_field_create_many)         | Create envelope fields     |
| [`documenso_envelopes_envelope_field_delete`](#documenso_envelopes_envelope_field_delete)                   | Delete envelope field      |
| [`documenso_envelopes_envelope_field_get`](#documenso_envelopes_envelope_field_get)                         | Get envelope field         |
| [`documenso_envelopes_envelope_field_update_many`](#documenso_envelopes_envelope_field_update_many)         | Update envelope fields     |
| [`documenso_envelopes_envelope_find`](#documenso_envelopes_envelope_find)                                   | Find envelopes             |
| [`documenso_envelopes_envelope_get`](#documenso_envelopes_envelope_get)                                     | Get envelope               |
| [`documenso_envelopes_envelope_get_many`](#documenso_envelopes_envelope_get_many)                           | Get multiple envelopes     |
| [`documenso_envelopes_envelope_item_create_many`](#documenso_envelopes_envelope_item_create_many)           | Create envelope items      |
| [`documenso_envelopes_envelope_item_delete`](#documenso_envelopes_envelope_item_delete)                     | Delete envelope item       |
| [`documenso_envelopes_envelope_item_download`](#documenso_envelopes_envelope_item_download)                 | Download an envelope item  |
| [`documenso_envelopes_envelope_item_update_many`](#documenso_envelopes_envelope_item_update_many)           | Update envelope items      |
| [`documenso_envelopes_envelope_recipient_create_many`](#documenso_envelopes_envelope_recipient_create_many) | Create envelope recipients |
| [`documenso_envelopes_envelope_recipient_delete`](#documenso_envelopes_envelope_recipient_delete)           | Delete envelope recipient  |
| [`documenso_envelopes_envelope_recipient_get`](#documenso_envelopes_envelope_recipient_get)                 | Get envelope recipient     |
| [`documenso_envelopes_envelope_recipient_update_many`](#documenso_envelopes_envelope_recipient_update_many) | Update envelope recipients |
| [`documenso_envelopes_envelope_redistribute`](#documenso_envelopes_envelope_redistribute)                   | Redistribute envelope      |
| [`documenso_envelopes_envelope_update`](#documenso_envelopes_envelope_update)                               | Update envelope            |
| [`documenso_envelopes_envelope_use`](#documenso_envelopes_envelope_use)                                     | Use envelope               |

***

## documenso\_envelopes\_envelope\_attachment\_create

Create attachment

**Parameters:**

| Parameter    | Type   | Required | Default | Description    |
| ------------ | ------ | -------- | ------- | -------------- |
| `data`       | object | Yes      | —       | The data value |
| `envelopeId` | string | Yes      | —       | Envelope Id    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "label": {
            "type": "string",
            "description": "The label value"
          },
          "data": {
            "type": "string",
            "description": "The data value"
          }
        },
        "required": [
          "label",
          "data"
        ]
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "data",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_attachment\_delete

Delete attachment

**Parameters:**

| Parameter | Type   | Required | Default | Description  |
| --------- | ------ | -------- | ------- | ------------ |
| `id`      | string | Yes      | —       | The id value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The id value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_attachment\_find

Find attachments

**Parameters:**

| Parameter    | Type   | Required | Default | Description     |
| ------------ | ------ | -------- | ------- | --------------- |
| `envelopeId` | string | Yes      | —       | Envelope Id     |
| `token`      | string | No       | —       | The token value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      },
      "token": {
        "type": "string",
        "description": "The token value"
      }
    },
    "required": [
      "PCID",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## 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   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "label": {
            "type": "string",
            "description": "The label value"
          },
          "data": {
            "type": "string",
            "description": "The data value"
          }
        },
        "required": [
          "label",
          "data"
        ]
      },
      "id": {
        "type": "string",
        "description": "The id value"
      }
    },
    "required": [
      "PCID",
      "data",
      "id"
    ]
  }
  ```
</Expandable>

***

## 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                       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope ID"
      },
      "page": {
        "type": "number",
        "description": "The pagination page number, starts at 1."
      },
      "perPage": {
        "type": "number",
        "description": "The number of items per page."
      },
      "orderByColumn": {
        "type": "string",
        "description": "Order By Column",
        "enum": [
          "createdAt"
        ]
      },
      "orderByDirection": {
        "type": "string",
        "description": "Order By Direction",
        "enum": [
          "asc",
          "desc"
        ]
      }
    },
    "required": [
      "PCID",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_create

Create envelope

**Parameters:**

| Parameter | Type   | Required | Default | Description       |
| --------- | ------ | -------- | ------- | ----------------- |
| `files`   | any\[] | No       | —       | The files value   |
| `payload` | object | Yes      | —       | The payload value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "files": {
        "type": "array",
        "description": "The files value"
      },
      "payload": {
        "type": "object",
        "description": "The payload value",
        "properties": {
          "title": {
            "type": "string",
            "description": "The title value"
          },
          "type": {
            "type": "string",
            "description": "The type value",
            "enum": [
              "DOCUMENT",
              "TEMPLATE"
            ]
          },
          "delegatedDocumentOwner": {
            "type": "string",
            "description": "Delegated Document Owner"
          },
          "externalId": {
            "type": "string",
            "description": "External Id"
          },
          "visibility": {
            "type": "string",
            "description": "The visibility value",
            "enum": [
              "EVERYONE",
              "MANAGER_AND_ABOVE",
              "ADMIN"
            ]
          },
          "globalAccessAuth": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ACCOUNT",
                "TWO_FACTOR_AUTH"
              ]
            },
            "description": "Global Access Auth"
          },
          "globalActionAuth": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ACCOUNT",
                "PASSKEY",
                "TWO_FACTOR_AUTH",
                "PASSWORD"
              ]
            },
            "description": "Global Action Auth"
          },
          "formValues": {
            "type": "object",
            "description": "Form Values"
          },
          "folderId": {
            "type": "string",
            "description": "Folder Id"
          },
          "recipients": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The recipients value"
          },
          "meta": {
            "type": "object",
            "description": "The meta value"
          },
          "attachments": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The attachments value"
          }
        },
        "required": [
          "title",
          "type"
        ]
      }
    },
    "required": [
      "PCID",
      "payload"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_delete

Delete envelope

**Parameters:**

| Parameter    | Type   | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `envelopeId` | string | Yes      | —       | Envelope Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_distribute

Distribute envelope

**Parameters:**

| Parameter    | Type   | Required | Default | Description    |
| ------------ | ------ | -------- | ------- | -------------- |
| `envelopeId` | string | Yes      | —       | Envelope Id    |
| `meta`       | object | No       | —       | The meta value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      },
      "meta": {
        "type": "object",
        "description": "The meta value",
        "properties": {
          "subject": {
            "type": "string",
            "description": "The subject value"
          },
          "message": {
            "type": "string",
            "description": "The message value"
          },
          "timezone": {
            "type": "string",
            "description": "Timezone identifier"
          },
          "dateFormat": {
            "type": "string",
            "description": "Date Format",
            "enum": [
              "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"
            ]
          },
          "distributionMethod": {
            "type": "string",
            "description": "Distribution Method",
            "enum": [
              "EMAIL",
              "NONE"
            ]
          },
          "redirectUrl": {
            "type": "string",
            "description": "Redirect Url"
          },
          "language": {
            "type": "string",
            "description": "The language value",
            "enum": [
              "de",
              "en",
              "fr",
              "es",
              "it",
              "nl",
              "pl",
              "pt-BR",
              "ja",
              "ko",
              "zh"
            ]
          },
          "emailId": {
            "type": "string",
            "description": "Email Id"
          },
          "emailReplyTo": {
            "type": "string",
            "description": "Email Reply To"
          },
          "emailSettings": {
            "type": "object",
            "description": "Email Settings"
          }
        }
      }
    },
    "required": [
      "PCID",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_duplicate

Duplicate envelope

**Parameters:**

| Parameter    | Type   | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `envelopeId` | string | Yes      | —       | Envelope Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## 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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "array",
        "description": "The data value"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "data",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_field\_delete

Delete envelope field

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `fieldId` | number | Yes      | —       | Field Id    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "fieldId": {
        "type": "number",
        "description": "Field Id"
      }
    },
    "required": [
      "PCID",
      "fieldId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_field\_get

Get envelope field

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `fieldId` | number | Yes      | —       | Field Id    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "fieldId": {
        "type": "number",
        "description": "Field Id"
      }
    },
    "required": [
      "PCID",
      "fieldId"
    ]
  }
  ```
</Expandable>

***

## 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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "array",
        "description": "The data value"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "data",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

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

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "query": {
        "type": "string",
        "description": "The search query."
      },
      "page": {
        "type": "number",
        "description": "The pagination page number, starts at 1."
      },
      "perPage": {
        "type": "number",
        "description": "The number of items per page."
      },
      "type": {
        "type": "string",
        "description": "Filter envelopes by type (DOCUMENT or TEMPLATE).",
        "enum": [
          "DOCUMENT",
          "TEMPLATE"
        ]
      },
      "templateId": {
        "type": "number",
        "description": "Filter envelopes by the template ID used to create it."
      },
      "source": {
        "type": "string",
        "description": "Filter envelopes by how it was created.",
        "enum": [
          "DOCUMENT",
          "TEMPLATE",
          "TEMPLATE_DIRECT_LINK"
        ]
      },
      "status": {
        "type": "string",
        "description": "Filter envelopes by the current status.",
        "enum": [
          "DRAFT",
          "PENDING",
          "COMPLETED",
          "REJECTED"
        ]
      },
      "folderId": {
        "type": "string",
        "description": "Filter envelopes by folder ID."
      },
      "orderByColumn": {
        "type": "string",
        "description": "Order By Column",
        "enum": [
          "createdAt"
        ]
      },
      "orderByDirection": {
        "type": "string",
        "description": "Sort direction.",
        "enum": [
          "asc",
          "desc"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_get

Get envelope

**Parameters:**

| Parameter    | Type   | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `envelopeId` | string | Yes      | —       | Envelope Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_get\_many

Get multiple envelopes

**Parameters:**

| Parameter | Type   | Required | Default | Description   |
| --------- | ------ | -------- | ------- | ------------- |
| `ids`     | object | Yes      | —       | The ids value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "ids": {
        "description": "The ids value"
      }
    },
    "required": [
      "PCID",
      "ids"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "files": {
        "type": "array",
        "description": "The files value"
      },
      "payload": {
        "type": "object",
        "description": "The payload value",
        "properties": {
          "envelopeId": {
            "type": "string",
            "description": "Envelope Id"
          }
        },
        "required": [
          "envelopeId"
        ]
      }
    },
    "required": [
      "PCID",
      "payload"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      },
      "envelopeItemId": {
        "type": "string",
        "description": "Envelope Item Id"
      }
    },
    "required": [
      "PCID",
      "envelopeId",
      "envelopeItemId"
    ]
  }
  ```
</Expandable>

***

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

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeItemId": {
        "type": "string",
        "description": "The ID of the envelope item to download."
      },
      "version": {
        "type": "string",
        "description": "The version of the envelope item to download. \"signed\" returns the completed document with signatures, \"original\" returns the original uploaded document.",
        "enum": [
          "original",
          "signed"
        ]
      }
    },
    "required": [
      "PCID",
      "envelopeItemId"
    ]
  }
  ```
</Expandable>

***

## 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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "envelopeItemId": {
              "type": "string",
              "description": "Envelope Item Id"
            },
            "order": {
              "type": "integer",
              "description": "The order value"
            },
            "title": {
              "type": "string",
              "description": "The title value"
            }
          },
          "required": [
            "envelopeItemId"
          ]
        },
        "description": "The data value"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "data",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## 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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "email": {
              "description": "The email value"
            },
            "name": {
              "type": "string",
              "description": "The name value"
            },
            "role": {
              "type": "string",
              "enum": [
                "CC",
                "SIGNER",
                "VIEWER",
                "APPROVER",
                "ASSISTANT"
              ],
              "description": "The role value"
            },
            "signingOrder": {
              "type": "number",
              "description": "Signing Order"
            },
            "accessAuth": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Access Auth"
            },
            "actionAuth": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Action Auth"
            }
          },
          "required": [
            "email",
            "name",
            "role"
          ]
        },
        "description": "The data value"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "data",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_recipient\_delete

Delete envelope recipient

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `recipientId` | number | Yes      | —       | Recipient Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "recipientId": {
        "type": "number",
        "description": "Recipient Id"
      }
    },
    "required": [
      "PCID",
      "recipientId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_recipient\_get

Get envelope recipient

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `recipientId` | number | Yes      | —       | Recipient Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "recipientId": {
        "type": "number",
        "description": "Recipient Id"
      }
    },
    "required": [
      "PCID",
      "recipientId"
    ]
  }
  ```
</Expandable>

***

## 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    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "The id value"
            },
            "email": {
              "description": "The email value"
            },
            "name": {
              "type": "string",
              "description": "The name value"
            },
            "role": {
              "type": "string",
              "enum": [
                "CC",
                "SIGNER",
                "VIEWER",
                "APPROVER",
                "ASSISTANT"
              ],
              "description": "The role value"
            },
            "signingOrder": {
              "type": "number",
              "description": "Signing Order"
            },
            "accessAuth": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Access Auth"
            },
            "actionAuth": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Action Auth"
            }
          },
          "required": [
            "id"
          ]
        },
        "description": "The data value"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      }
    },
    "required": [
      "PCID",
      "data",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_redistribute

Redistribute envelope

**Parameters:**

| Parameter    | Type      | Required | Default | Description          |
| ------------ | --------- | -------- | ------- | -------------------- |
| `envelopeId` | string    | Yes      | —       | Envelope Id          |
| `recipients` | number\[] | Yes      | —       | The recipients value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      },
      "recipients": {
        "type": "array",
        "items": {
          "type": "number"
        },
        "description": "The recipients value"
      }
    },
    "required": [
      "PCID",
      "envelopeId",
      "recipients"
    ]
  }
  ```
</Expandable>

***

## 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 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "title": {
            "type": "string",
            "description": "The title value"
          },
          "externalId": {
            "type": "string",
            "description": "External Id"
          },
          "visibility": {
            "type": "string",
            "description": "The visibility value",
            "enum": [
              "EVERYONE",
              "MANAGER_AND_ABOVE",
              "ADMIN"
            ]
          },
          "globalAccessAuth": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ACCOUNT",
                "TWO_FACTOR_AUTH"
              ]
            },
            "description": "Global Access Auth"
          },
          "globalActionAuth": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ACCOUNT",
                "PASSKEY",
                "TWO_FACTOR_AUTH",
                "PASSWORD"
              ]
            },
            "description": "Global Action Auth"
          },
          "folderId": {
            "type": "string",
            "description": "Folder Id"
          },
          "templateType": {
            "type": "string",
            "description": "Template Type",
            "enum": [
              "PUBLIC",
              "PRIVATE",
              "ORGANISATION"
            ]
          }
        }
      },
      "envelopeId": {
        "type": "string",
        "description": "Envelope Id"
      },
      "meta": {
        "type": "object",
        "description": "The meta value",
        "properties": {
          "subject": {
            "type": "string",
            "description": "The subject value"
          },
          "message": {
            "type": "string",
            "description": "The message value"
          },
          "timezone": {
            "type": "string",
            "description": "Timezone identifier"
          },
          "dateFormat": {
            "type": "string",
            "description": "Date Format",
            "enum": [
              "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"
            ]
          },
          "distributionMethod": {
            "type": "string",
            "description": "Distribution Method",
            "enum": [
              "EMAIL",
              "NONE"
            ]
          },
          "signingOrder": {
            "type": "string",
            "description": "Signing Order",
            "enum": [
              "PARALLEL",
              "SEQUENTIAL"
            ]
          },
          "allowDictateNextSigner": {
            "type": "boolean",
            "description": "Allow Dictate Next Signer"
          },
          "redirectUrl": {
            "type": "string",
            "description": "Redirect Url"
          },
          "language": {
            "type": "string",
            "description": "The language value",
            "enum": [
              "de",
              "en",
              "fr",
              "es",
              "it",
              "nl",
              "pl",
              "pt-BR",
              "ja",
              "ko",
              "zh"
            ]
          },
          "typedSignatureEnabled": {
            "type": "boolean",
            "description": "Typed Signature Enabled"
          },
          "uploadSignatureEnabled": {
            "type": "boolean",
            "description": "Upload Signature Enabled"
          },
          "drawSignatureEnabled": {
            "type": "boolean",
            "description": "Draw Signature Enabled"
          },
          "emailId": {
            "type": "string",
            "description": "Email Id"
          },
          "emailReplyTo": {
            "type": "string",
            "description": "Email Reply To"
          },
          "emailSettings": {
            "type": "object",
            "description": "Email Settings"
          },
          "envelopeExpirationPeriod": {
            "description": "Envelope Expiration Period"
          },
          "reminderSettings": {
            "type": "object",
            "description": "Reminder Settings"
          }
        }
      }
    },
    "required": [
      "PCID",
      "envelopeId"
    ]
  }
  ```
</Expandable>

***

## documenso\_envelopes\_envelope\_use

Use envelope

**Parameters:**

| Parameter | Type   | Required | Default | Description       |
| --------- | ------ | -------- | ------- | ----------------- |
| `files`   | any\[] | No       | —       | The files value   |
| `payload` | object | Yes      | —       | The payload value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "files": {
        "type": "array",
        "description": "The files value"
      },
      "payload": {
        "type": "object",
        "description": "The payload value",
        "properties": {
          "envelopeId": {
            "type": "string",
            "description": "Envelope Id"
          },
          "externalId": {
            "type": "string",
            "description": "External Id"
          },
          "recipients": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The recipients value"
          },
          "distributeDocument": {
            "type": "boolean",
            "description": "Distribute Document"
          },
          "customDocumentData": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Custom Document Data"
          },
          "folderId": {
            "type": "string",
            "description": "Folder Id"
          },
          "prefillFields": {
            "type": "array",
            "description": "Prefill Fields"
          },
          "override": {
            "type": "object",
            "description": "The override value"
          },
          "attachments": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The attachments value"
          },
          "formValues": {
            "type": "object",
            "description": "Form Values"
          }
        },
        "required": [
          "envelopeId"
        ]
      }
    },
    "required": [
      "PCID",
      "payload"
    ]
  }
  ```
</Expandable>