# Docusign eSignature REST API API

> Docusign eSignature REST API API on Apizie: 400 endpoints (Retrieves the available REST API versions., Lists resources for REST version specified, Creates new accounts., Retrieves the account information for the specified account., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/ecommerce:docusign/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:docusign`
- Category: E-commerce
- Status: byok
- Source: https://developers.docusign.com/
- Page: https://www.apizie.tech/api/ecommerce/docusign
- OpenAPI: https://www.apizie.tech/api/ecommerce/docusign/openapi.json

The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.

## Endpoints

### Retrieves the available REST API versions.
`GET https://www.apizie.tech/v1/ecommerce:docusign/service-information-get-service-information` (byok)

### Lists resources for REST version specified
`GET https://www.apizie.tech/v1/ecommerce:docusign/service-information-get-resource-information` (byok)

### Creates new accounts.
`POST https://www.apizie.tech/v1/ecommerce:docusign/accounts-post-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieves the account information for the specified account.
`GET https://www.apizie.tech/v1/ecommerce:docusign/accounts-get-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| include_account_settings | string | no | When **true,** includes account settings in the response. The default value is **false.** |
| include_trial_eligibility | string | no |  |

### Deletes the specified account.
`POST https://www.apizie.tech/v1/ecommerce:docusign/accounts-delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| redact_user_data | string | no |  |

### Gets list of recurring and usage charges for the account.
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-charges-get-account-billing-charges` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| include_charges | string | no | Specifies which billing charges to return. Valid values are: * envelopes * seats |

### Get a List of Billing Invoices
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-invoices-get-billing-invoices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| from_date | string | no | Specifies the date/time of the earliest invoice in the account to retrieve. |
| to_date | string | no | Specifies the date/time of the latest invoice in the account to retrieve. |

### Retrieves a billing invoice.
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-invoices-get-billing-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| invoiceId | string | yes | The ID of the invoice. |

### Get a list of past due invoices.
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-invoices-get-billing-invoices-past-due` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Gets payment information for one or more payments.
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-payments-get-payment-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| from_date | string | no | Specifies the date/time of the earliest payment in the account to retrieve. |
| to_date | string | no | Specifies the date/time of the latest payment in the account to retrieve. |

### Posts a payment to a past due invoice.
`POST https://www.apizie.tech/v1/ecommerce:docusign/billing-payments-post-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Gets billing payment information for a specific payment.
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-payments-get-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| paymentId | string | yes | The ID of the payment. |

### Get Account Billing Plan
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-plan-get-billing-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| include_credit_card_information | string | no | When **true,** payment information including credit card information will show in the return. |
| include_downgrade_information | string | no |  |
| include_metadata | string | no | When **true,** the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to… |
| include_successor_plans | string | no | When **true,** excludes successor information from the response. |
| include_tax_exempt_id | string | no |  |

### Updates an account billing plan.
`POST https://www.apizie.tech/v1/ecommerce:docusign/billing-plan-put-billing-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| preview_billing_plan | string | no | When **true,** updates the account using a preview billing plan. |
| body | object | no | JSON request body |

### Get credit card information
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-plan-get-credit-card-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Returns downgrade plan information for the specified account.
`GET https://www.apizie.tech/v1/ecommerce:docusign/billing-plan-get-downgrade-request-billing-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Queues downgrade billing plan request for an account.
`POST https://www.apizie.tech/v1/ecommerce:docusign/billing-plan-put-downgrade-account-billing-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Reserved: Purchase additional envelopes.
`POST https://www.apizie.tech/v1/ecommerce:docusign/purchased-envelopes-put-purchased-envelopes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Gets a list of brands.
`GET https://www.apizie.tech/v1/ecommerce:docusign/brands-get-brands` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| exclude_distributor_brand | string | no | When **true,** excludes distributor brand information from the response set. |
| include_logos | string | no | When **true,** returns the logos associated with the brand. |

### Creates one or more brand profiles for an account.
`POST https://www.apizie.tech/v1/ecommerce:docusign/brands-post-brands` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Deletes one or more brand profiles.
`POST https://www.apizie.tech/v1/ecommerce:docusign/brands-delete-brands` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Gets information about a brand.
`GET https://www.apizie.tech/v1/ecommerce:docusign/brand-get-brand` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |
| include_external_references | string | no | When **true,** the landing pages and links associated with the brand are included in the response. |
| include_logos | string | no | When **true,** the URIs for the logos associated with the brand are included in the response. |

### Updates an existing brand.
`POST https://www.apizie.tech/v1/ecommerce:docusign/brand-put-brand` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |
| replace_brand | string | no | When **true,** replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The… |
| body | object | no | JSON request body |

### Deletes a brand.
`POST https://www.apizie.tech/v1/ecommerce:docusign/brand-delete-brand` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |

### Exports a brand.
`GET https://www.apizie.tech/v1/ecommerce:docusign/brand-export-get-brand-export-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |

### Gets a brand logo.
`GET https://www.apizie.tech/v1/ecommerce:docusign/brand-logo-get-brand-logo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |
| logoType | string | yes | The type of logo. Valid values are: - `primary` - `secondary` - `email` |

### Updates a brand logo.
`POST https://www.apizie.tech/v1/ecommerce:docusign/brand-logo-put-brand-logo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |
| logoType | string | yes | The type of logo. Valid values are: - `primary` - `secondary` - `email` |

### Deletes a brand logo.
`POST https://www.apizie.tech/v1/ecommerce:docusign/brand-logo-delete-brand-logo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |
| logoType | string | yes | The type of logo. Valid values are: - `primary` - `secondary` - `email` |

### Returns metadata about the branding resources for an account.
`GET https://www.apizie.tech/v1/ecommerce:docusign/brand-resources-get-brand-resources-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |

### Returns a branding resource file.
`GET https://www.apizie.tech/v1/ecommerce:docusign/brand-resources-get-brand-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |
| resourceContentType | string | yes | The type of brand resource file to return. Valid values are: - `sending` - `signing` - `email` - `signing_captive` |
| langcode | string | no | The ISO 3166-1 alpha-2 codes for the languages that the brand supports. |
| return_master | string | no | Specifies which resource file data to return. When **true,** only the master resource file is returned. When **false,** only the elements… |

### Updates a branding resource file.
`POST https://www.apizie.tech/v1/ecommerce:docusign/brand-resources-put-brand-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| brandId | string | yes | The ID of the brand. |
| resourceContentType | string | yes | The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive` |
| body | object | yes | Form fields as a JSON object |

### Returns a list of bulk send batch summaries.
`GET https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-batch-get-bulk-send-batches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| batch_ids | string | no | A comma-separated list of batch IDs to query. |
| count | string | no | The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`… |
| from_date | string | no | The start date for a date range in UTC DateTime format. |
| search_text | string | no | Use this parameter to search for specific text. |
| start_position | string | no | The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default… |
| status | string | no | The kind of results to collect. Must be one of: - all - failed - sent - queued |
| to_date | string | no | The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are… |
| user_id | string | no |  |

### Gets the status of a specific bulk send batch.
`GET https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-batch-get-bulk-send-batch-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkSendBatchId | string | yes | The batch ID. |

### Updates the name of a bulk send batch.
`POST https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-batch-put-bulk-send-batch-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkSendBatchId | string | yes | The batch ID. |
| body | object | no | JSON request body |

### Applies a bulk action to all envelopes from a specified bulk send.
`POST https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-batch-put-bulk-send-batch-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkAction | string | yes | The action to apply. Valid values: * `resend` * `correct` * `void` |
| bulkSendBatchId | string | yes | The batch ID. |
| body | object | no | JSON request body |

### Gets envelopes from a specific bulk send batch.
`GET https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-envelopes-get-bulk-send-batch-envelopes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkSendBatchId | string | yes | The batch ID. |
| count | string | no | The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `1000` |
| include | string | no | When `recipients`, only envelopes with recipient nodes will be included in the response. |
| order | string | no | The order in which to sort the results. Valid values are: - Descending order: `desc` (default) - Ascending order: `asc` |
| order_by | string | no | The envelope attribute used to sort the results. Valid values are: - `created` (default) - `completed` - `last_modified` - `sent` -… |
| search_text | string | no | Use this parameter to search for specific text. |
| start_position | string | no | The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default… |
| status | string | no | Comma-separated list of envelope statuses. Note that `any` should not be included with other statuses. In other words, `any` is a valid… |

### Gets bulk send lists.
`GET https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-crud-get-bulk-send-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Creates a bulk send list.
`POST https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-crud-post-bulk-send-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The ID of the account. |
| body | object | no | JSON request body |

### Gets a specific bulk send list.
`GET https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-crud-get-bulk-send-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkSendListId | string | yes | The GUID of the bulk send list. This property is created after you post a new bulk send list. |

### Updates a bulk send list.
`POST https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-crud-put-bulk-send-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkSendListId | string | yes | The GUID of the bulk send list. This property is created after you post a new bulk send list. |
| body | object | no | JSON request body |

### Deletes a bulk send list.
`POST https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-crud-delete-bulk-send-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkSendListId | string | yes | The GUID of the bulk send list. This property is created after you post a new bulk send list. |

### Creates a bulk send request.
`POST https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-send-post-bulk-send-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkSendListId | string | yes | The GUID of the bulk send list. This property is created after you post a new bulk send list. |
| body | object | no | JSON request body |

### Creates a bulk send test.
`POST https://www.apizie.tech/v1/ecommerce:docusign/bulk-send-v2-test-post-bulk-send-test-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| bulkSendListId | string | yes | The GUID of the bulk send list. This property is created after you post a new bulk send list. |
| body | object | no | JSON request body |

### Deletes the signature for one or more captive recipient records.
`POST https://www.apizie.tech/v1/ecommerce:docusign/captive-recipients-delete-captive-recipients-part` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| recipientPart | string | yes | Signature is the only supported value. |
| body | object | no | JSON request body |

### Initiate a new chunked upload.
`POST https://www.apizie.tech/v1/ecommerce:docusign/chunked-uploads-post-chunked-uploads` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | Form fields as a JSON object |

### Retrieves metadata about a chunked upload.
`GET https://www.apizie.tech/v1/ecommerce:docusign/chunked-uploads-get-chunked-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| chunkedUploadId | string | yes | The ID of the chunked upload. |
| include | string | no | (Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`,… |

### Commit a chunked upload.
`POST https://www.apizie.tech/v1/ecommerce:docusign/chunked-uploads-put-chunked-uploads` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | (Required) The external account number (int) or account ID GUID. |
| chunkedUploadId | string | yes | (Required) The ID of the chunked upload to commit. |
| action | string | no | (Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload… |

### Deletes a chunked upload.
`POST https://www.apizie.tech/v1/ecommerce:docusign/chunked-uploads-delete-chunked-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| chunkedUploadId | string | yes | The ID of the chunked upload. |

### Add a chunk to an existing chunked upload.
`POST https://www.apizie.tech/v1/ecommerce:docusign/chunked-uploads-put-chunked-upload-part` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| chunkedUploadId | string | yes | The ID of the chunked upload. |
| chunkedUploadPartSeq | string | yes | The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create… |
| body | object | no | JSON request body |

### Get Connect configuration information.
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-get-connect-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Creates a Connect configuration.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-post-connect-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Updates a specified Connect configuration.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-put-connect-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Gets the details about a Connect configuration.
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-get-connect-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| connectId | string | yes | The ID of the custom Connect configuration being accessed. |

### Deletes the specified Connect configuration.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-delete-connect-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| connectId | string | yes | The ID of the custom Connect configuration being accessed. |

### Returns all users from the configured Connect service.
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-get-connect-all-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| connectId | string | yes | The ID of the custom Connect configuration being accessed. |
| count | string | no | The maximum number of results to return. |
| domain_users_only | string | no |  |
| email_substring | string | no | Filters returned user records by full email address or a substring of email address. |
| start_position | string | no | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image. |
| status | string | no | The status of the item. |
| user_name_substring | string | no | Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character. |

### Returns users from the configured Connect service.
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-get-connect-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| connectId | string | yes | The ID of the custom Connect configuration being accessed. |
| count | string | no | The maximum number of results to return. Use `start_position` to specify the number of results to skip. |
| email_substring | string | no | Filters returned user records by full email address or a substring of email address. |
| list_included_users | string | no |  |
| start_position | string | no | The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default… |
| status | string | no | Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired *… |
| user_name_substring | string | no | Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character. |

### Republishes Connect information for the specified envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-publish-put-connect-retry-by-envelope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |

### Submits a batch of historical envelopes for republish to a webhook.
`POST https://www.apizie.tech/v1/ecommerce:docusign/historical-envelope-publish-post-historical-envelope-publish` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Republishes Connect information for multiple envelopes.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-publish-put-connect-retry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Gets the Connect failure log information.
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-failures-get-connect-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| from_date | string | no | The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied. |
| to_date | string | no | The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are… |

### Deletes a Connect failure log entry.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-failures-delete-connect-failure-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| failureId | string | yes | The ID of the Connect post failure. Use `all` to delete all failures for the account. |

### Gets the Connect log.
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-log-get-connect-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| from_date | string | no | The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied. |
| to_date | string | no | The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are… |

### Deletes a list of Connect log entries.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-log-delete-connect-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Gets a Connect log entry.
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-log-get-connect-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| logId | string | yes | The ID of the Connect log entry. |
| additional_info | string | no | When **true,** the response includes the `connectDebugLog` information. |

### Deletes a specified Connect log entry.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-log-delete-connect-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| logId | string | yes | The ID of the Connect log entry. Use `all` to delete all entries for the account. |

### Retrieves the Connect OAuth information for the account.
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-oauth-config-get-connect-oauth-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Set up Connect OAuth for the specified account.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-oauth-config-post-connect-oauth-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Updates the existing Connect OAuth configuration for the account.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-oauth-config-put-connect-oauth-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Delete the Connect OAuth configuration.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-oauth-config-delete-connect-oauth-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### GET /v2.1/accounts/{accountId}/connect/secret
`GET https://www.apizie.tech/v1/ecommerce:docusign/connect-hmac-get-connect-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Generates a new connect HMAC Secret.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-hmac-create-connect-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Deletes the connect HMAC Secret for specified account.
`POST https://www.apizie.tech/v1/ecommerce:docusign/connect-hmac-delete-connect-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| keyId | string | yes |  |

### Gets the default Electronic Record and Signature Disclosure for an account.
`GET https://www.apizie.tech/v1/ecommerce:docusign/consumer-disclosure-get-consumer-disclosure` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| langCode | string | no | The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic… |

### Gets the Electronic Record and Signature Disclosure for an account.
`GET https://www.apizie.tech/v1/ecommerce:docusign/consumer-disclosure-get-consumer-disclosure-lang-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| langCode | string | yes | The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic… |

### Updates the Electronic Record and Signature Disclosure for an account.
`POST https://www.apizie.tech/v1/ecommerce:docusign/consumer-disclosure-put-consumer-disclosure` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| langCode | string | yes | The code for the signer language version of the disclosure that you want to update. The following languages are supported: - Arabic (`ar`)… |
| include_metadata | string | no | (Optional) When true, the response includes metadata indicating which properties are editable. |
| body | object | no | JSON request body |

### Add contacts to a contacts list.
`POST https://www.apizie.tech/v1/ecommerce:docusign/contacts-post-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Updates one or more contacts.
`POST https://www.apizie.tech/v1/ecommerce:docusign/contacts-put-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Deletes multiple contacts from an account.
`POST https://www.apizie.tech/v1/ecommerce:docusign/contacts-delete-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| body | object | no | JSON request body |

### Gets one or more contacts.
`GET https://www.apizie.tech/v1/ecommerce:docusign/contacts-get-contact-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| contactId | string | yes | The ID of a contact person in the account's address book. **Note:** To return all contacts, omit this parameter. It is not required. |
| cloud_provider | string | no | (Optional) The cloud provider from which to retrieve the contacts. Valid values are: - `rooms` - `docusignCore` (default) |

### Deletes a contact.
`POST https://www.apizie.tech/v1/ecommerce:docusign/contacts-delete-contact-with-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| contactId | string | yes | The ID of a contact person in the account's address book. |

### Gets a list of custom fields.
`GET https://www.apizie.tech/v1/ecommerce:docusign/account-custom-fields-get-account-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |

### Creates an account custom field.
`POST https://www.apizie.tech/v1/ecommerce:docusign/account-custom-fields-post-account-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| apply_to_templates | string | no | (Optional) When **true,** the new custom field is applied to all of the templates on the account. |
| body | object | no | JSON request body |

### Updates an account custom field.
`POST https://www.apizie.tech/v1/ecommerce:docusign/account-custom-fields-put-account-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| customFieldId | string | yes | The ID of the custom field. |
| apply_to_templates | string | no |  |
| body | object | no | JSON request body |

### Deletes an account custom field.
`POST https://www.apizie.tech/v1/ecommerce:docusign/account-custom-fields-delete-account-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| customFieldId | string | yes | The ID of the custom field. |
| apply_to_templates | string | no |  |

### Search for specific sets of envelopes by using search filters.
`GET https://www.apizie.tech/v1/ecommerce:docusign/envelopes-get-envelopes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| ac_status | string | no | Specifies the authoritative copy status for the envelopes. Valid values: * `Unknown` * `Original` * `Transferred` * `AuthoritativeCopy` *… |
| block | string | no | Reserved for Docusign. |
| cdse_mode | string | no | Reserved for Docusign. |
| continuation_token | string | no | Reserved for Docusign. |
| count | string | no | The maximum number of results to return. The maximum value is 1000. To get the next or previous set of envelopes, use `nextUri` or… |
| custom_field | string | no | Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format:… |
| email | string | no | Limit results to envelopes sent by the account user with this email address. `user_name` must be given as well, and both `email` and… |
| envelope_ids | string | no | Comma separated list of `envelopeId` values. |
| exclude | string | no | Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`). Valid values: - `recipients` -… |
| folder_ids | string | no | Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder GUIDs or the following values: -… |
| folder_types | string | no | Returns the envelopes from folders of a specific type. Enter as a comma-separated list of the following values: - `normal` - `inbox` -… |
| from_date | string | no | Specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are… |
| from_to_status | string | no | This is the status type checked for in the `from_date`/`to_date` period. For example, if `Created` is specified, then envelopes created… |
| include | string | no | Specifies additional information to return about the envelopes. Use a comma-separated list, such as `folders, recipients` to specify… |
| include_purge_information | string | no | When **true,** information about envelopes that have been deleted is included in the response. |
| intersecting_folder_ids | string | no | A comma-separated list of folders from which you want to get envelopes. Valid values: - `normal` - `inbox` - `sentitems` - `draft` -… |
| last_queried_date | string | no | Returns envelopes that were modified prior to the specified date and time. Example: `2020-05-09T21:56:12.2500000Z` |
| order | string | no | Returns envelopes in either ascending (`asc`) or descending (`desc`) order. |
| order_by | string | no | Sorts results according to a specific property. Valid values: - `last_modified` - `action_required` - `created` - `completed` -… |
| powerformids | string | no | A comma-separated list of `PowerFormId` values. |
| query_budget | string | no | The time in seconds that the query should run before returning data. |
| requester_date_format | string | no |  |
| search_mode | string | no |  |
| search_text | string | no | Free text search criteria that you can use to filter the list of envelopes that is returned. |
| start_position | string | no | The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default… |
| status | string | no | A comma-separated list of current envelope statuses to be included in the response. Valid values: * `completed` * `created` * `declined` *… |
| to_date | string | no | Specifies the date and time to stop looking for status changes. The default is the current date and time. Although you can use any date… |
| transaction_ids | string | no | A comma-separated list of envelope transaction IDs. Getting envelope status by transaction IDs is useful for offline signing situations to… |
| user_filter | string | no | Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid… |
| user_id | string | no | The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account… |
| user_name | string | no | Limit results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name`… |

### Creates an envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/envelopes-post-envelopes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| cdse_mode | string | no | Reserved for Docusign. |
| change_routing_order | string | no | When true, users can define the routing order of recipients while sending documents for signature. |
| completed_documents_only | string | no | Reserved for Docusign. |
| merge_roles_on_draft | string | no | When **true,** template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft… |
| body | object | no | JSON request body |

### Gets the status of a single envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/envelopes-get-envelope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| advanced_update | string | no | When **true,** envelope information can be added or modified. |
| include | string | no | Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:… |
| include_anchor_tab_locations | string | no | When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.** |
| user_id | string | no |  |

### Send, void, or modify a draft envelope. Purge documents from a completed envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/envelopes-put-envelope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| advanced_update | string | no | When **true,** allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. |
| recycle_on_void | string | no |  |
| resend_envelope | string | no | When **true,** sends the specified envelope again. |
| body | object | no | JSON request body |

### Returns a list of envelope attachments associated with a specified envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/attachments-get-attachments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |

### Adds one or more envelope attachments to a draft or in-process envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/attachments-put-attachments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Deletes one or more envelope attachments from a draft envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/attachments-delete-attachments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Retrieves an envelope attachment from an envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/attachments-get-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| attachmentId | string | yes | The unique identifier for the attachment. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |

### Updates an envelope attachment in a draft or in-process envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/attachments-put-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| attachmentId | string | yes | The unique identifier for the attachment. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Gets the envelope audit events for an envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/audit-events-get-audit-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| locale | string | no | The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` -… |

### Gets a PDF transcript of all of the comments in an envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/comments-get-comments-transcript` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| encoding | string | no | (Optional) The encoding to use for the file. |

### Gets the custom field information for the specified envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/custom-fields-get-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |

### Creates envelope custom fields for an envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/custom-fields-post-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Updates envelope custom fields in an envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/custom-fields-put-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Deletes envelope custom fields for draft and in-process envelopes.
`POST https://www.apizie.tech/v1/ecommerce:docusign/custom-fields-delete-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Returns sender fields for an envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/doc-gen-form-fields-get-envelope-doc-gen-form-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |

### Updates sender fields for an envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/doc-gen-form-fields-put-envelope-doc-gen-form-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| update_docgen_formfields_only | string | no | When **false** or omitted, the documents are updated. When **true,** only the form fields are updated. The documents are unchanged. |
| body | object | no | JSON request body |

### Gets a list of documents in an envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/documents-get-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| documents_by_userid | string | no | When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders… |
| include_agreement_type | string | no |  |
| include_docgen_formfields | string | no | Reserved for Docusign. |
| include_is_edited | string | no |  |
| include_metadata | string | no | When **true,** the response includes metadata that indicates which properties the sender can edit. |
| include_tabs | string | no | Reserved for Docusign. |
| recipient_id | string | no | Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to… |
| shared_user_id | string | no | The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in… |

### Adds one or more documents to an existing envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/documents-put-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Deletes documents from a draft envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/documents-delete-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Retrieves a single document or all documents from an envelope.
`GET https://www.apizie.tech/v1/ecommerce:docusign/documents-get-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The ID of the document to retrieve. Alternatively, you can use one of the following special keywords: - `combined`: Retrieves all of the… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| certificate | string | no | Used only when the `documentId` parameter is the special keyword `combined`. When **true,** the certificate of completion is included in… |
| documents_by_userid | string | no | When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders… |
| encoding | string | no | Reserved for Docusign. |
| encrypt | string | no | When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can… |
| language | string | no | Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese… |
| recipient_id | string | no | Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to… |
| shared_user_id | string | no | The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in… |
| show_changes | string | no | When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The… |
| watermark | string | no | When **true,** the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is… |

### Adds or replaces a document in an existing envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/documents-put-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |

### Gets the custom document fields from an existing envelope document.
`GET https://www.apizie.tech/v1/ecommerce:docusign/document-fields-get-document-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |

### Creates custom document fields in an existing envelope document.
`POST https://www.apizie.tech/v1/ecommerce:docusign/document-fields-post-document-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Updates existing custom document fields in an existing envelope document.
`POST https://www.apizie.tech/v1/ecommerce:docusign/document-fields-put-document-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Deletes custom document fields from an existing envelope document.
`POST https://www.apizie.tech/v1/ecommerce:docusign/document-fields-delete-document-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Retrieves the HTML definition used to generate a dynamically sized responsive document.
`GET https://www.apizie.tech/v1/ecommerce:docusign/responsive-html-get-envelope-document-html-definitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The GUID of the document. Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744 |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |

### Returns document page images based on input.
`GET https://www.apizie.tech/v1/ecommerce:docusign/pages-get-page-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| count | string | no | The maximum number of results to return. |
| dpi | string | no | The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94. |
| max_height | string | no | Sets the maximum height of the returned images in pixels. |
| max_width | string | no | Sets the maximum width of the returned images in pixels. |
| nocache | string | no | When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value. |
| show_changes | string | no | When **true,** changes display in the user interface. |
| start_position | string | no | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image. |

### Deletes a page from a document in an envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/pages-delete-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| pageNumber | string | yes | The page number being accessed. |

### Gets a page image from an envelope for display.
`GET https://www.apizie.tech/v1/ecommerce:docusign/pages-get-page-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| pageNumber | string | yes | The page number being accessed. |
| dpi | string | no | Sets the dots per inch (DPI) for the returned image. |
| max_height | string | no | Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting. |
| max_width | string | no | Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting. |
| show_changes | string | no | When **true,** changes display in the user interface. |

### Rotates page image from an envelope for display.
`POST https://www.apizie.tech/v1/ecommerce:docusign/pages-put-page-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| pageNumber | string | yes | The page number being accessed. |
| body | object | no | JSON request body |

### Returns tabs on the specified page.
`GET https://www.apizie.tech/v1/ecommerce:docusign/tabs-get-page-tabs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| pageNumber | string | yes | The page number being accessed. |

### Creates a preview of the responsive version of a document.
`POST https://www.apizie.tech/v1/ecommerce:docusign/responsive-html-post-document-responsive-html-preview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Returns the tabs on a document.
`GET https://www.apizie.tech/v1/ecommerce:docusign/tabs-get-document-tabs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| include_metadata | string | no | When **true,** the response includes metadata indicating which properties are editable. |
| page_numbers | string | no | Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs. Example: `page_numbers=2,6`… |

### Adds tabs to a document in an envelope.
`POST https://www.apizie.tech/v1/ecommerce:docusign/tabs-post-document-tabs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

### Updates the tabs for document.
`POST https://www.apizie.tech/v1/ecommerce:docusign/tabs-put-document-tabs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The external account number (int) or account ID GUID. |
| documentId | string | yes | The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.… |
| envelopeId | string | yes | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
| body | object | no | JSON request body |

…and 280 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/ecommerce:docusign/service-information-get-service-information" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Docusign eSignature REST API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/ecommerce:docusign/service-information-get-service-information with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Docusign eSignature REST API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Docusign eSignature REST API itself also needs your own key from docusign.

### Can AI agents use the Docusign eSignature REST API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:docusign.

### What is the status of the Docusign eSignature REST API API?
Needs your own provider key (bring your own key)