PUT
/v2.1/accounts/{accountId}/billing_plan/downgrade
Queues downgrade billing plan request for an account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/billing_plan/credit_card
Get credit card information
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes
Reserved: Purchase additional envelopes.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/billing_plan/downgrade
Returns downgrade plan information for the specified account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1
Lists resources for REST version specified
POST
/v2.1/accounts
Creates new accounts.
GET
/v2.1/accounts/provisioning
Retrieves the account provisioning information for the account.
DELETE
/v2.1/accounts/{accountId}
Deletes the specified account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}
Retrieves the account information for the specified account.
accountId path · required — The external account number (int) or account ID GUID.include_account_settings query — When **true,** includes account settings in the response. The default value is **false.**
GET
/v2.1/accounts/{accountId}/billing_charges
Gets list of recurring and usage charges for the account.
accountId path · required — The external account number (int) or account ID GUID.include_charges query — Specifies which billing charges to return. Valid values are: * envelopes * seats
GET
/v2.1/accounts/{accountId}/billing_invoices
Get a List of Billing Invoices
accountId path · required — The external account number (int) or account ID GUID.from_date query — Specifies the date/time of the earliest invoice in the account to retrieve.to_date query — Specifies the date/time of the latest invoice in the account to retrieve.
GET
/v2.1/accounts/{accountId}/billing_invoices/{invoiceId}
Retrieves a billing invoice.
accountId path · required — The external account number (int) or account ID GUID.invoiceId path · required — The ID of the invoice.
GET
/v2.1/accounts/{accountId}/billing_invoices_past_due
Get a list of past due invoices.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/billing_payments
Gets payment information for one or more payments.
accountId path · required — The external account number (int) or account ID GUID.from_date query — Specifies the date/time of the earliest payment in the account to retrieve.to_date query — Specifies the date/time of the latest payment in the account to retrieve.
POST
/v2.1/accounts/{accountId}/billing_payments
Posts a payment to a past due invoice.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/billing_payments/{paymentId}
Gets billing payment information for a specific payment.
accountId path · required — The external account number (int) or account ID GUID.paymentId path · required — The ID of the payment.
GET
/v2.1/accounts/{accountId}/billing_plan
Get Account Billing Plan
accountId path · required — The external account number (int) or account ID GUID.include_credit_card_information query — When **true,** payment information including credit card information will show in the return.include_downgrade_information queryinclude_metadata query — When **true,** the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to the `billingAddress` information.include_successor_plans query — When **true,** excludes successor information from the response.include_tax_exempt_id query
PUT
/v2.1/accounts/{accountId}/billing_plan
Updates an account billing plan.
accountId path · required — The external account number (int) or account ID GUID.preview_billing_plan query — When **true,** updates the account using a preview billing plan.
DELETE
/v2.1/accounts/{accountId}/brands
Deletes one or more brand profiles.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/brands
Gets a list of brands.
accountId path · required — The external account number (int) or account ID GUID.exclude_distributor_brand query — When **true,** excludes distributor brand information from the response set.include_logos query — When **true,** returns the logos associated with the brand.
POST
/v2.1/accounts/{accountId}/brands
Creates one or more brand profiles for an account.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/brands/{brandId}
Deletes a brand.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.
GET
/v2.1/accounts/{accountId}/brands/{brandId}
Gets information about a brand.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.include_external_references query — When **true,** the landing pages and links associated with the brand are included in the response.include_logos query — When **true,** the URIs for the logos associated with the brand are included in the response.
PUT
/v2.1/accounts/{accountId}/brands/{brandId}
Updates an existing brand.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.replace_brand query — When **true,** replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The default value is **false.**
GET
/v2.1/accounts/{accountId}/brands/{brandId}/file
Exports a brand.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.
DELETE
/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}
Deletes a brand logo.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.logoType path · required — The type of logo. Valid values are: - `primary` - `secondary` - `email`
GET
/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}
Gets a brand logo.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.logoType path · required — The type of logo. Valid values are: - `primary` - `secondary` - `email`
PUT
/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}
Updates a brand logo.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.logoType path · required — The type of logo. Valid values are: - `primary` - `secondary` - `email`
GET
/v2.1/accounts/{accountId}/brands/{brandId}/resources
Returns metadata about the branding resources for an account.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.
GET
/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}
Returns a branding resource file.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.resourceContentType path · required — The type of brand resource file to return. Valid values are: - `sending` - `signing` - `email` - `signing_captive`langcode query — The ISO 3166-1 alpha-2 codes for the languages that the brand supports.return_master query — Specifies which resource file data to return. When **true,** only the master resource file is returned. When **false,** only the elements that you modified are returned.
PUT
/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}
Updates a branding resource file.
accountId path · required — The external account number (int) or account ID GUID.brandId path · required — The ID of the brand.resourceContentType path · required — The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
DELETE
/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}
Deletes the signature for one or more captive recipient records.
accountId path · required — The external account number (int) or account ID GUID.recipientPart path · required — Signature is the only supported value.
GET
/v2.1/accounts/{accountId}/bulk_send_batch
Returns a list of bulk send batch summaries.
accountId path · required — The external account number (int) or account ID GUID.batch_ids query — A comma-separated list of batch IDs to query.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100` Default: `100`from_date query — The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.search_text query — Use this parameter to search for specific text.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.status query — The kind of results to collect. Must be one of: - all - failed - sent - queuedto_date query — 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 returned. **Note:** If this property is null, the value defaults to the current date.user_id query
GET
/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}
Gets the status of a specific bulk send batch.
accountId path · required — The external account number (int) or account ID GUID.bulkSendBatchId path · required — The batch ID.
PUT
/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}
Updates the name of a bulk send batch.
accountId path · required — The external account number (int) or account ID GUID.bulkSendBatchId path · required — The batch ID.
GET
/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes
Gets envelopes from a specific bulk send batch.
accountId path · required — The external account number (int) or account ID GUID.bulkSendBatchId path · required — The batch ID.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `1000`include query — When `recipients`, only envelopes with recipient nodes will be included in the response.order query — The order in which to sort the results. Valid values are: - Descending order: `desc` (default) - Ascending order: `asc`order_by query — The envelope attribute used to sort the results. Valid values are: - `created` (default) - `completed` - `last_modified` - `sent` - `status` - `subject` - `status_changed`search_text query — Use this parameter to search for specific text.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.status query — Comma-separated list of envelope statuses. Note that `any` should not be included with other statuses. In other words, `any` is a valid parameter value, but `any,sent` is not. Use the value `deliveryfailure` to get all envelopes with `AuthFailed` and `AutoResponded` status. This value is specific to bulk sending.
PUT
/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}
Applies a bulk action to all envelopes from a specified bulk send.
accountId path · required — The external account number (int) or account ID GUID.bulkAction path · required — The action to apply. Valid values: * `resend` * `correct` * `void`bulkSendBatchId path · required — The batch ID.
GET
/v2.1/accounts/{accountId}/bulk_send_lists
Gets bulk send lists.
accountId path · required — The external account number (int) or account ID GUID.
POST
/v2.1/accounts/{accountId}/bulk_send_lists
Creates a bulk send list.
accountId path · required — The ID of the account.
DELETE
/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
Deletes a bulk send list.
accountId path · required — The external account number (int) or account ID GUID.bulkSendListId path · required — The GUID of the bulk send list. This property is created after you post a new bulk send list.
GET
/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
Gets a specific bulk send list.
accountId path · required — The external account number (int) or account ID GUID.bulkSendListId path · required — The GUID of the bulk send list. This property is created after you post a new bulk send list.
PUT
/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
Updates a bulk send list.
accountId path · required — The external account number (int) or account ID GUID.bulkSendListId path · required — The GUID of the bulk send list. This property is created after you post a new bulk send list.
POST
/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send
Creates a bulk send request.
accountId path · required — The external account number (int) or account ID GUID.bulkSendListId path · required — The GUID of the bulk send list. This property is created after you post a new bulk send list.
POST
/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test
Creates a bulk send test.
accountId path · required — The external account number (int) or account ID GUID.bulkSendListId path · required — The GUID of the bulk send list. This property is created after you post a new bulk send list.
POST
/v2.1/accounts/{accountId}/chunked_uploads
Initiate a new chunked upload.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
Deletes a chunked upload.
accountId path · required — The external account number (int) or account ID GUID.chunkedUploadId path · required — The ID of the chunked upload.
GET
/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
Retrieves metadata about a chunked upload.
accountId path · required — The external account number (int) or account ID GUID.chunkedUploadId path · required — The ID of the chunked upload.include query — (Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.
PUT
/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
Commit a chunked upload.
accountId path · required — (Required) The external account number (int) or account ID GUID.chunkedUploadId path · required — (Required) The ID of the chunked upload to commit.action query — (Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload for use with other API calls.
PUT
/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}
Add a chunk to an existing chunked upload.
accountId path · required — The external account number (int) or account ID GUID.chunkedUploadId path · required — The ID of the chunked upload.chunkedUploadPartSeq path · required — 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 request is `0`. **Note:** You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it.
GET
/v2.1/accounts/{accountId}/connect
Get Connect configuration information.
accountId path · required — The external account number (int) or account ID GUID.
POST
/v2.1/accounts/{accountId}/connect
Creates a Connect configuration.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/connect
Updates a specified Connect configuration.
accountId path · required — The external account number (int) or account ID GUID.
POST
/v2.1/accounts/{accountId}/connect/envelopes/publish/historical
Submits a batch of historical envelopes for republish to a webhook.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/connect/envelopes/retry_queue
Republishes Connect information for multiple envelopes.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue
Republishes Connect information for the specified envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/connect/failures
Gets the Connect failure log information.
accountId path · required — The external account number (int) or account ID GUID.from_date query — The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.to_date query — 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 returned. **Note:** If this property is null, the value defaults to the current date.
DELETE
/v2.1/accounts/{accountId}/connect/failures/{failureId}
Deletes a Connect failure log entry.
accountId path · required — The external account number (int) or account ID GUID.failureId path · required — The ID of the Connect post failure. Use `all` to delete all failures for the account.
DELETE
/v2.1/accounts/{accountId}/connect/logs
Deletes a list of Connect log entries.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/custom_fields/{customFieldId}
Deletes an account custom field.
accountId path · required — The external account number (int) or account ID GUID.customFieldId path · required — The ID of the custom field.apply_to_templates query
GET
/v2.1/accounts/{accountId}/connect/logs
Gets the Connect log.
accountId path · required — The external account number (int) or account ID GUID.from_date query — The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.to_date query — 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 returned. **Note:** If this property is null, the value defaults to the current date.
DELETE
/v2.1/accounts/{accountId}/connect/logs/{logId}
Deletes a specified Connect log entry.
accountId path · required — The external account number (int) or account ID GUID.logId path · required — The ID of the Connect log entry.
GET
/v2.1/accounts/{accountId}/connect/logs/{logId}
Gets a Connect log entry.
accountId path · required — The external account number (int) or account ID GUID.logId path · required — The ID of the Connect log entry.additional_info query — When **true,** the response includes the `connectDebugLog` information.
DELETE
/v2.1/accounts/{accountId}/connect/oauth
Delete the Connect OAuth configuration.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/connect/oauth
Retrieves the Connect OAuth information for the account.
accountId path · required — The external account number (int) or account ID GUID.
POST
/v2.1/accounts/{accountId}/connect/oauth
Set up Connect OAuth for the specified account.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/connect/oauth
Updates the existing Connect OAuth configuration for the account.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/connect/{connectId}
Deletes the specified Connect configuration.
accountId path · required — The external account number (int) or account ID GUID.connectId path · required — The ID of the custom Connect configuration being accessed.
GET
/v2.1/accounts/{accountId}/connect/{connectId}
Gets the details about a Connect configuration.
accountId path · required — The external account number (int) or account ID GUID.connectId path · required — The ID of the custom Connect configuration being accessed.
GET
/v2.1/accounts/{accountId}/connect/{connectId}/all/users
Returns all users from the configured Connect service.
accountId path · required — The external account number (int) or account ID GUID.connectId path · required — The ID of the custom Connect configuration being accessed.count query — The maximum number of results to return.domain_users_only queryemail_substring query — Filters returned user records by full email address or a substring of email address.start_position query — 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 query — The status of the item.user_name_substring query — 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.
GET
/v2.1/accounts/{accountId}/connect/{connectId}/users
Returns users from the configured Connect service.
accountId path · required — The external account number (int) or account ID GUID.connectId path · required — The ID of the custom Connect configuration being accessed.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip.email_substring query — Filters returned user records by full email address or a substring of email address.list_included_users querystart_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.status query — Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disableduser_name_substring query — 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.
PUT
/v2.1/accounts/{accountId}/custom_fields/{customFieldId}
Updates an account custom field.
accountId path · required — The external account number (int) or account ID GUID.customFieldId path · required — The ID of the custom field.apply_to_templates query
GET
/v2.1/accounts/{accountId}/envelopes
Search for specific sets of envelopes by using search filters.
accountId path · required — The external account number (int) or account ID GUID.ac_status query — Specifies the Authoritative Copy Status for the envelopes. Valid values: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.block query — Reserved for DocuSign.cdse_mode query — Reserved for DocuSign.continuation_token query — A token returned in the response to a previous API call that is used to resume a search query from a specific point.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip.custom_field query — Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value` Example: If you have an envelope custom field named "Region" and you want to search for all envelopes where the value is "West" you would use set this parameter to `Region=West`.email query — Limit results to envelopes sent by the account user with this email address. `user_name` must be given as well, and both `email` and `user_name` must refer to an existing account user.envelope_ids query — Comma separated list of `envelopeId` values.exclude query — Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`). Valid values are: - `recipients` - `powerforms` - `folders`folder_ids query — Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values: - `awaiting_my_signature` - `completed` - `draft` - `drafts` - `expiring_soon` - `inbox` - `out_for_signature` - `recyclebin` - `sentitems` - `waiting_for_others`folder_types query — A comma-separated list of folder types you want to retrieve envelopes from. Valid values are: - `normal` - `inbox` - `sentitems` - `draft` - `templates`from_date query — Specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are set. Although you can use any date format supported by the .NET system library's [`DateTime.Parse()`][msoft] function, DocuSign recommends using [ISO 8601][] format dates with an explicit time zone offset If you do not provide a time zone offset, the method uses the server's time zone. For example, the following dates and times refer to the same instant: * `2017-05-02T01:44Z` * `2017-05-01T21:44-04:00` * `2017-05-01T18:44-07:00` [msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601from_to_status query — This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.include query — Specifies additional information to return about the envelopes. Use a comma-separated list, such as `folders, recipients` to specify information. Valid values are: - `custom_fields`: The custom fields associated with the envelope. - `documents`: The documents associated with the envelope. - `attachments`: The attachments associated with the envelope. - `extensions`: Information about the email settings associated with the envelope. - `folders`: The folders where the envelope exists. - `recipients`: The recipients associated with the envelope. - `powerform`: The PowerForms associated with the envelope. - `payment_tabs`: The payment tabs associated with the envelope.include_purge_information query — When **true,** information about envelopes that have been deleted is included in the response.intersecting_folder_ids query — A comma-separated list of folders that you want want to get envelopes from. Valid values are: - `normal` - `inbox` - `sentitems` - `draft` - `templates`last_queried_date query — Returns envelopes that were modified prior to the specified date and time. Example: `2020-05-09T21:56:12.2500000Z`order query — Returns envelopes in either ascending (`asc`) or descending (`desc`) order.order_by query — Sorts results according to a specific property. Valid values are: - `last_modified` - `action_required` - `created` - `completed` - `envelope_name` - `expire` - `sent` - `signer_list` - `status` - `subject` - `user_name` - `status_changed` - `last_modified`powerformids query — A comma-separated list of `PowerFormId` values.query_budget query — The time in seconds that the query should run before returning data.requester_date_format querysearch_text query — Free text search criteria that you can use to filter the list of envelopes that is returned.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.status query — A comma-separated list of current envelope statuses to included in the response. Possible values are: * `completed` * `created` * `declined` * `deleted` * `delivered` * `processing` * `sent` * `signed` * `timedout` * `voided` The `any` value is equivalent to any status.to_date query — 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 format supported by the .NET system library's [`DateTime.Parse()`][msoft] function, DocuSign recommends using [ISO 8601][] format dates with an explicit time zone offset If you do not provide a time zone offset, the method uses the server's time zone. For example, the following dates and times refer to the same instant: * `2017-05-02T01:44Z` * `2017-05-01T21:44-04:00` * `2017-05-01T18:44-07:00` [msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601transaction_ids query — If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days.user_filter query — Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid values are: - `sender` - `recipient` - `recipient_only`user_id query — 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 access can retrieve envelopes by user_id from the account.user_name query — 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` must refer to an existing account user.
GET
/v2.1/accounts/{accountId}/consumer_disclosure
Gets the default Electronic Record and Signature Disclosure for an account.
accountId path · required — The external account number (int) or account ID GUID.langCode query — The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.
GET
/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}
Gets the Electronic Record and Signature Disclosure for an account.
accountId path · required — The external account number (int) or account ID GUID.langCode path · required — The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.
PUT
/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}
Updates the Electronic Record and Signature Disclosure for an account.
accountId path · required — The external account number (int) or account ID GUID.langCode path · required — The code for the signer language version of the disclosure that you want to update. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.include_metadata query — (Optional) When true, the response includes metadata indicating which properties are editable.
DELETE
/v2.1/accounts/{accountId}/contacts
Deletes multiple contacts from an account.
accountId path · required — The external account number (int) or account ID GUID.
POST
/v2.1/accounts/{accountId}/contacts
Add contacts to a contacts list.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/contacts
Updates one or more contacts.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/contacts/{contactId}
Deletes a contact.
accountId path · required — The external account number (int) or account ID GUID.contactId path · required — The ID of a contact person in the account's address book.
GET
/v2.1/accounts/{accountId}/contacts/{contactId}
Gets one or more contacts.
accountId path · required — The external account number (int) or account ID GUID.contactId path · required — 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 query — (Optional) The cloud provider from which to retrieve the contacts. Valid values are: - `rooms` - `docusignCore` (default)
GET
/v2.1/accounts/{accountId}/custom_fields
Gets a list of custom fields.
accountId path · required — The external account number (int) or account ID GUID.
POST
/v2.1/accounts/{accountId}/custom_fields
Creates an account custom field.
accountId path · required — The external account number (int) or account ID GUID.apply_to_templates query — (Optional) When **true,** the new custom field is applied to all of the templates on the account.
POST
/v2.1/accounts/{accountId}/envelopes
Creates an envelope.
accountId path · required — The external account number (int) or account ID GUID.cdse_mode query — Reserved for DocuSign.change_routing_order query — When true, users can define the routing order of recipients while sending documents for signature.completed_documents_only query — Reserved for DocuSign.merge_roles_on_draft query — When **true,** template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.) **Note:** DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.
PUT
/v2.1/accounts/{accountId}/envelopes/status
Gets envelope statuses for a set of envelopes.
accountId path · required — The external account number (int) or account ID GUID.ac_status query — Specifies the Authoritative Copy Status for the envelopes. Valid values: - `Unknown` - `Original` - `Transferred` - `AuthoritativeCopy` - `AuthoritativeCopyExportPending` - `AuthoritativeCopyExported` - `DepositPending` - `Deposited` - `DepositedEO` - `DepositFailed`block query — When **true,** removes any results that match one of the provided `transaction_ids`.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip.email query — The email address of the sender.envelope_ids query — The envelope IDs to include in the results. The value of this property can be: - A comma-separated list of envelope IDs - The special value `request_body`. In this case, the method uses the envelope IDs in the request body.from_date query — The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are provided. **Note:** This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified.from_to_status query — The envelope status that you are checking for. Possible values are: - `Changed` (default) - `Completed` - `Created` - `Declined` - `Deleted` - `Delivered` - `Processing` - `Sent` - `Signed` - `TimedOut` - `Voided` For example, if you specify `Changed`, this method returns a list of envelopes that changed status during the `from_date` to `to_date` time period.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.status query — A comma-separated list of envelope status to search for. Possible values are: - `completed` - `created` - `declined` - `deleted` - `delivered` - `processing` - `sent` - `signed` - `template` - `voided`to_date query — Optional date/time setting that specifies the last date/time or envelope status changes in the result set. The default value is the time that you call the method.transaction_ids query — The transaction IDs to include in the results. Note that transaction IDs are valid for seven days. The value of this property can be: - A list of comma-separated transaction IDs - The special value `request_body`. In this case, this method uses the transaction IDs in the request body.user_name query — Limits results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name` must refer to an existing account user.
GET
/v2.1/accounts/{accountId}/envelopes/transfer_rules
Gets envelope transfer rules.
accountId path · required — The external account number (int) or account ID GUID.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
POST
/v2.1/accounts/{accountId}/envelopes/transfer_rules
Creates an envelope transfer rule.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/envelopes/transfer_rules
Changes the status of multiple envelope transfer rules.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}
Deletes an envelope transfer rule.
accountId path · required — The external account number (int) or account ID GUID.envelopeTransferRuleId path · required — The ID of the envelope transfer rule. The system generates this ID when the rule is first created.
PUT
/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}
Changes the status of an envelope transfer rule.
accountId path · required — The external account number (int) or account ID GUID.envelopeTransferRuleId path · required — The ID of the envelope transfer rule. The system generates this ID when the rule is first created.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}
Gets the status of a single envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`advanced_update query — When **true,** envelope information can be added or modified.include query — Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are: - `custom_fields`: The custom fields associated with the envelope. - `documents`: The documents associated with the envelope. - `attachments`: The attachments associated with the envelope. - `extensions`: The email settings associated with the envelope. - `folders`: The folder where the envelope exists. - `recipients`: The recipients associated with the envelope. - `powerform`: The PowerForms associated with the envelope. - `tabs`: The tabs associated with the envelope. - `payment_tabs`: The payment tabs associated with the envelope. - `workflow`: The workflow definition associated with the envelope.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}
Send, void, or modify a draft envelope. Purge documents from a completed envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`advanced_update query — When **true,** allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.resend_envelope query — When **true,** sends the specified envelope again.
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
Deletes one or more attachments from a draft envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
Returns a list of attachments associated with a specified envelope
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
Adds one or more attachments to a draft or in-process envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}
Retrieves an attachment from an envelope.
accountId path · required — The external account number (int) or account ID GUID.attachmentId path · required — The unique identifier for the attachment.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}
Adds an attachment to a draft or in-process envelope.
accountId path · required — The external account number (int) or account ID GUID.attachmentId path · required — The unique identifier for the attachment.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events
Gets the envelope audit events for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript
Gets a PDF transcript of all of the comments in an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`encoding query — (Optional) The encoding to use for the file.
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
Deletes envelope custom fields for draft and in-process envelopes.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
Gets the custom field information for the specified envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
Creates envelope custom fields for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
Updates envelope custom fields in an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
Deletes documents from a draft envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions
Retrieves the HTML definition used to generate a dynamically sized responsive document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The GUID of the document. Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates
Get List of Templates used in an Envelope
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`include query — The possible value is `matching_applied`, which returns template matching information for the template.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
Gets a list of documents in an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`documents_by_userid query — When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.include_docgen_formfields queryinclude_metadata query — When **true,** the response includes metadata that indicates which properties the sender can edit.include_tabs query — When **true,** information about the tabs, including prefill tabs, associated with the documents are included in the response.recipient_id query — Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this to work.shared_user_id query — 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 the context of a shared inbox (i.e., when you share envelopes from one user to another through the DocuSign Admin console).
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
Adds one or more documents to an existing envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
Retrieves a single document or all documents from an envelope.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The ID of the document to retrieve. Alternatively, you can use one of the following special keywords: - `combined`: Retrieves all of the documents as a single PDF file. When the query parameter `certificate` is **true,** the certificate of completion is included in the PDF file. When the query parameter `certificate` is **false,** the certificate of completion is not included in the PDF file. - `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the certificate of completion. - `certificate`: Retrieves only the certificate of completion as a PDF file. - `portfolio`: Retrieves the envelope documents as a [PDF portfolio](https://helpx.adobe.com/acrobat/using/overview-pdf-portfolios.html).envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`certificate query — Used only when the `documentId` parameter is the special keyword `combined`. When **true,** the certificate of completion is included in the combined PDF file. When **false,** (the default) the certificate of completion is not included in the combined PDF file.documents_by_userid query — When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.encoding query — Reserved for DocuSign.encrypt query — When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.language query — Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).recipient_id query — Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this functionality to work.shared_user_id query — 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 the context of a shared inbox (i.e., when you share envelopes from one user to another through the DocuSign Admin console).show_changes query — When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The account must have the **Highlight Data Changes** feature enabled.watermark query — When **true,** the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
Adds or replaces a document in an existing envelope.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields
Deletes custom document fields from an existing envelope document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields
Gets the custom document fields from an existing envelope document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields
Creates custom document fields in an existing envelope document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields
Updates existing custom document fields in an existing envelope document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages
Returns document page images based on input.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`count query — The maximum number of results to return.dpi query — The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.max_height query — Sets the maximum height of the returned images in pixels.max_width query — Sets the maximum width of the returned images in pixels.nocache query — When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value.show_changes query — When **true,** changes display in the user interface.start_position query — The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}
Deletes a page from a document in an envelope.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`pageNumber path · required — The page number being accessed.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image
Gets a page image from an envelope for display.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`pageNumber path · required — The page number being accessed.dpi query — Sets the dots per inch (DPI) for the returned image.max_height query — Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.max_width query — Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.show_changes query — When **true,** changes display in the user interface.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image
Rotates page image from an envelope for display.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`pageNumber path · required — The page number being accessed.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs
Returns tabs on the specified page.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`pageNumber path · required — The page number being accessed.
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview
Creates a preview of the responsive version of a document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct
Returns a URL to the envelope correction UI.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
Deletes tabs from a document in an envelope.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
Returns the tabs on a document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`include_metadata query — When **true,** the response includes metadata indicating which properties are editable.page_numbers query — 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` Note: You can only enter individual page numbers, and not a page range.
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
Adds tabs to a document in an envelope.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
Updates the tabs for document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates
Gets the templates associated with a document in an existing envelope.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`include query — A comma-separated list that limits the results. Valid values are: * `applied` * `matched`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates
Adds templates to a document in an envelope.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`preserve_template_recipient query — If omitted or set to false (the default), envelope recipients _will be removed_ if the template being applied includes only tabs positioned via anchor text for the recipient, and none of the documents include the anchor text. When **true,** the recipients _will be preserved_ after the template is applied.
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates
Adds templates to an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`preserve_template_recipient query — If omitted or set to false (the default), envelope recipients _will be removed_ if the template being applied includes only tabs positioned via anchor text for the recipient, and none of the documents include the anchor text. When **true,** the recipients _will be preserved_ after the template is applied.
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}
Deletes a template from a document in an existing envelope.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Deletes the email setting overrides for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Gets the email setting overrides for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Adds email setting overrides to an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
Updates the email setting overrides for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data
Returns envelope tab data for an existing envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions
Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
Deletes an envelope lock.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
Gets envelope lock information.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
Locks an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
Updates an envelope lock.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification
Gets envelope notification information.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification
Sets envelope notifications for an existing envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
Deletes recipients from an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
Gets the status of recipients for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`include_anchor_tab_locations query — When **true** and `include_tabs` value is set to **true,** all tabs with anchor tab properties are included in the response.include_extended query — When **true,** the extended properties are included in the response.include_metadata query — Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).include_tabs query — When **true,** the tab information associated with the recipient is included in the response.
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
Adds one or more recipients to an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`resend_envelope query — When **true,** forces the envelope to be resent if it would not be resent otherwise. Ordinarily, if the recipient's routing order is before or the same as the envelope's next recipient, the envelope is not resent. Setting this query parameter to **false** has no effect and is the same as omitting it altogether.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`combine_same_order_recipients query — When **true,** recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://support.docusign.com/en/guides/ndse-user-guide-manage-automatic-template-matching), and is based on Recipient Role and Routing Order.offline_signing query — Indicates if offline signing is enabled for the recipient when a network connection is unavailable.resend_envelope query — When **true,** forces the envelope to be resent if it would not be resent otherwise. Ordinarily, if the recipient's routing order is before or the same as the envelope's next recipient, the envelope is not resent. Setting this query parameter to **false** has no effect and is the same as omitting it altogether.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility
Updates document visibility for recipients
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}
Deletes a recipient from an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure
Gets the default Electronic Record and Signature Disclosure for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.langCode query — (Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image
Retrieve signature image information for a signer/sign-in-person recipient.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.include_chrome query — When **true,** the response includes the chromed version of the signature image.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}
Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`langCode path · required — (Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.langCode query — (Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility
Returns document visibility for a recipient
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility
Updates document visibility for a recipient
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token
Creates a resource token for a sender to request ID Evidence data.
accountId path · required — The account ID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — The `recipientIdGuid`.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
Gets the initials image for a user.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.include_chrome query — The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
Sets the initials image for an accountless signer.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature
Gets signature information for a signer or sign-in-person recipient.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image
Sets the signature image for an accountless signer.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
Deletes the tabs associated with a recipient. **Note:** It is an error to delete a tab that has the `templateLocked` property set to true. This property corresponds to the **Restrict changes** option in the web app.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
Gets the tabs information for a signer or sign-in-person recipient in an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.include_anchor_tab_locations query — When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**include_metadata query — When **true,** the response includes metadata indicating which properties are editable.
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
Adds tabs for a recipient.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
Updates the tabs for a recipient.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review
Create the link to the page for manually reviewing IDs.
accountId path · required — A value that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the [AppsI and Keys](https://support.docusign.com/en/guides/ndse-admin-guide-api-and-keys) page.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`recipientId path · required — A GUID value that DocuSign assigns to identify each recipient in an envelope. This value is globally unique for all recipients, not just those in your account. The specified recipient must belong to a workflow that allows the [manual review](https://support.docusign.com/en/guides/Identity-Verification-DocuSign-eSignature-Admin-Guide) of IDs. In addition, the status of the automatic verification for this recipient must return `Failed` and the value of the `vendorFailureStatusCode` field must be `MANUAL_REVIEW_STARTED` as shown in the following extract of a response to the [GET ENVELOPE](/docs/esign-rest-api/reference/envelopes/envelopes/get/) method: ``` "recipientAuthenticationStatus": { "identityVerificationResult": { "status": "Failed", "eventTimestamp": "2020-09-04T16:59:42.8045667Z", "vendorFailureStatusCode": "MANUAL_REVIEW_STARTED" } } ```
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview
Creates a preview of the responsive versions of all of the documents in an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob
Reserved for DocuSign.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob
Reserved for DocuSign.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct
Revokes the correction view URL to the Envelope UI.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit
Returns a URL to the edit view UI.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient
Returns a URL to the recipient view UI.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The ID of the draft envelope or template to preview.
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview
Creates an envelope recipient preview.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender
Returns a URL to the sender view UI.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared
Returns a URL to the shared recipient view UI for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
Delete the workflow definition for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
Returns the workflow definition for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
Updates the workflow definition for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
Deletes the scheduled sending rules for the envelope's workflow.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
Returns the scheduled sending rules for an envelope's workflow definition.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
Updates the scheduled sending rules for an envelope's workflow.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps
Adds a new step to an envelope's workflow.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
Deletes a workflow step from an envelope's workflow definition.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`workflowStepId path · required — The ID of the workflow step.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
Returns a specified workflow step for a specified template.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`workflowStepId path · required — The ID of the workflow step.
PUT
/v2.1/accounts/{accountId}/settings/envelope_purge_configuration
Sets the envelope purge configuration for an account.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
Updates the specified workflow step for an envelope.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`workflowStepId path · required — The ID of the workflow step.
DELETE
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
Deletes the delayed routing rules for the specified envelope workflow step.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`workflowStepId path · required — The ID of the workflow step.
GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
Returns the delayed routing rules for an envelope's workflow step definition.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`workflowStepId path · required — The ID of the workflow step.
PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
Updates the delayed routing rules for an envelope's workflow step definition.
accountId path · required — The external account number (int) or account ID GUID.envelopeId path · required — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`workflowStepId path · required — The ID of the workflow step.
DELETE
/v2.1/accounts/{accountId}/favorite_templates
Remove one or more templates from the account favorites.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/favorite_templates
Retrieves the list of favorite templates for the account.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/favorite_templates
Set one or more templates as account favorites.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/folders
Gets a list of the folders for the account.
accountId path · required — The external account number (int) or account ID GUID.count query — The maximum number of results to return.include query — A comma-separated list of folder types to include in the response. Valid values are: - `envelope_folders`: Returns a list of envelope folders. (Default) - `template_folders`: Returns a list of template folders. - `shared_template_folders`: Returns a list of shared template folders.include_items query — Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.start_position query — The zero-based index of the result from which to start returning results. The default value is `0`.sub_folder_depth query — If missing or any value other than `-1`, the returned list contains only the top-level folders. A value of `-1` returns the complete folder hierarchy.template query — This parameter is deprecated as of version 2.1. Use `include` instead.user_filter query — Narrows down the resulting folder list by the following values: - `all`: Returns all templates owned or shared with the user. (default) - `owned_by_me`: Returns only templates the user owns. - `shared_with_me`: Returns only templates that are shared with the user.
GET
/v2.1/accounts/{accountId}/folders/{folderId}
Gets information about the specified folder.
accountId path · required — The external account number (int) or account ID GUID.folderId path · required — The ID of the folder.from_date query — Reserved for DocuSign.include_items query — Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.owner_email query — Reserved for DocuSign.owner_name query — Reserved for DocuSign.search_text query — Reserved for DocuSign.start_position query — Reserved for DocuSign.status query — Reserved for DocuSign.to_date query — Reserved for DocuSign.
PUT
/v2.1/accounts/{accountId}/folders/{folderId}
Moves an envelope from its current folder to the specified folder.
accountId path · required — The external account number (int) or account ID GUID.folderId path · required — The ID of the folder.
DELETE
/v2.1/accounts/{accountId}/groups
Deletes an existing user group.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/groups
Gets information about groups associated with the account.
accountId path · required — The external account number (int) or account ID GUID.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`group_type query — The type of group to return. Valid values: * `AdminGroup` * `CustomGroup` * `EveryoneGroup`include_usercount query — When **true,** every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is **true.**search_text query — Filters the results of a GET request based on the text that you specify.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
POST
/v2.1/accounts/{accountId}/groups
Creates one or more groups for the account.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/groups
Updates the group information for a group.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/groups/{groupId}/brands
Deletes brand information from a group.
accountId path · required — The external account number (int) or account ID GUID.groupId path · required — The ID of the group.
GET
/v2.1/accounts/{accountId}/groups/{groupId}/brands
Gets the brand information for a group.
accountId path · required — The external account number (int) or account ID GUID.groupId path · required — The ID of the group.
PUT
/v2.1/accounts/{accountId}/groups/{groupId}/brands
Adds an existing brand to a group.
accountId path · required — The external account number (int) or account ID GUID.groupId path · required — The ID of the group being accessed.
DELETE
/v2.1/accounts/{accountId}/groups/{groupId}/users
Deletes one or more users from a group
accountId path · required — The external account number (int) or account ID GUID.groupId path · required — The ID of the group being accessed.
GET
/v2.1/accounts/{accountId}/groups/{groupId}/users
Gets a list of users in a group.
accountId path · required — The external account number (int) or account ID GUID.groupId path · required — The ID of the group being accessed.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
PUT
/v2.1/accounts/{accountId}/groups/{groupId}/users
Adds one or more users to an existing group.
accountId path · required — The external account number (int) or account ID GUID.groupId path · required — The ID of the group being accessed.
GET
/v2.1/accounts/{accountId}/identity_verification
Retrieves the Identity Verification workflows available to an account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/payment_gateway_accounts
List payment gateway accounts
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/permission_profiles
Gets a list of permission profiles.
accountId path · required — The external account number (int) or account ID GUID.include query — A comma-separated list of additional properties to return in the response. Valid values are: - `user_count`: The total number of users associated with the permission profile. - `closed_users`: Includes closed users in the `user_count`. - `account_management`: The account management settings. - `metadata`: Metadata indicating whether the properties associated with the account permission profile are editable. Example: `user_count,closed_users`
POST
/v2.1/accounts/{accountId}/permission_profiles
Creates a new permission profile for an account.
accountId path · required — The external account number (int) or account ID GUID.include query — A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.
GET
/v2.1/accounts/{accountId}/settings/notification_defaults
Gets envelope notification defaults.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
Deletes a permission profile from an account.
accountId path · required — The external account number (int) or account ID GUID.permissionProfileId path · required — The ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the **Settings > Permission Profiles** page of your eSignature account page.move_users_to query
GET
/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
Returns a permission profile for an account.
accountId path · required — The external account number (int) or account ID GUID.permissionProfileId path · required — The ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the **Settings > Permission Profiles** page of your eSignature account page.include query — A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.
PUT
/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
Updates a permission profile.
accountId path · required — The external account number (int) or account ID GUID.permissionProfileId path · required — The ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the **Settings > Permission Profiles** page of your eSignature account page.include query — A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.
DELETE
/v2.1/accounts/{accountId}/powerforms
Deletes one or more PowerForms.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/powerforms
Returns a list of PowerForms.
accountId path · required — The external account number (int) or account ID GUID.from_date query — The start date for a date range. **Note:** If no value is provided, no date filtering is applied.order query — The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.order_by query — The file attribute to use to sort the results. Valid values are: - `sender` - `auth` - `used` - `remaining` - `lastused` - `status` - `type` - `templatename` - `created`search_fields query — A comma-separated list of additional properties to include in a search. - `sender`: Include sender name and email in the search. - `recipients`: Include recipient names and emails in the search. - `envelope`: Include envelope information in the search.search_text query — Use this parameter to search for specific text.to_date query — The end date for a date range. **Note:** If no value is provided, this property defaults to the current date.
POST
/v2.1/accounts/{accountId}/powerforms
Creates a new PowerForm
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/powerforms/senders
Gets PowerForm senders.
accountId path · required — The external account number (int) or account ID GUID.start_position query — The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
DELETE
/v2.1/accounts/{accountId}/powerforms/{powerFormId}
Deletes a PowerForm.
accountId path · required — The external account number (int) or account ID GUID.powerFormId path · required — The ID of the PowerForm.
GET
/v2.1/accounts/{accountId}/powerforms/{powerFormId}
Returns a single PowerForm.
accountId path · required — The external account number (int) or account ID GUID.powerFormId path · required — The ID of the PowerForm.
PUT
/v2.1/accounts/{accountId}/powerforms/{powerFormId}
Updates an existing PowerForm.
accountId path · required — The external account number (int) or account ID GUID.powerFormId path · required — The ID of the PowerForm.
PUT
/v2.1/accounts/{accountId}/settings/notification_defaults
Updates envelope notification default settings.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/settings/password_rules
Gets the password rules for an account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data
Returns the data that users entered in a PowerForm.
accountId path · required — The external account number (int) or account ID GUID.powerFormId path · required — The ID of the PowerForm.data_layout query — The layout in which to return the PowerForm data. Valid values are: - `Native` - `Csv_Classic` - `Csv_One_Envelope_Per_Line` - `Xml_Classic`from_date query — The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.to_date query — The end date of a date range in UTC DateTime format. The default value is `UtcNow`.
GET
/v2.1/accounts/{accountId}/recipient_names
Gets the recipient names associated with an email address.
accountId path · required — (Required) The external account number (int) or account ID GUID.email query — The email address for which you want to retrieve recipient names.
GET
/v2.1/accounts/{accountId}/seals
Returns available seals for specified account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/search_folders/{searchFolderId}
Gets a list of envelopes in folders matching the specified criteria.
accountId path · required — The external account number (int) or account ID GUID.searchFolderId path · required — Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.all query — Specifies that all envelopes that match the criteria are returned.count query — 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 query — Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.include_recipients query — When **true,** the recipient information is returned in the response.order query — Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.order_by query — Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.to_date query — Specifies the end of the date range to return.
GET
/v2.1/accounts/{accountId}/settings
Gets account settings information.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/settings
Updates the account settings for an account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/settings/bcc_email_archives
Gets the BCC email archive configurations for an account.
accountId path · required — The external account number (int) or account ID GUID.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
POST
/v2.1/accounts/{accountId}/settings/bcc_email_archives
Creates a BCC email archive configuration.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}
Deletes a BCC email archive configuration.
accountId path · required — The external account number (int) or account ID GUID.bccEmailArchiveId path · required — The ID of the BCC email archive configuration.
GET
/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}
Gets a BCC email archive configuration and its history.
accountId path · required — The external account number (int) or account ID GUID.bccEmailArchiveId path · required — The ID of the BCC email archive configuration.count query — The maximum number of results to return. Use `start_position` to specify the number of items to skip.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
DELETE
/v2.1/accounts/{accountId}/settings/enote_configuration
Deletes configuration information for the eNote eOriginal integration.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/settings/enote_configuration
Returns the configuration information for the eNote eOriginal integration.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/settings/enote_configuration
Updates configuration information for the eNote eOriginal integration.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/settings/envelope_purge_configuration
Gets the envelope purge configuration for an account.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/settings/password_rules
Updates the password rules for an account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/settings/tabs
Returns tab settings list for specified account
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/settings/tabs
Modifies tab settings for specified account
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/shared_access
Reserved: Gets the shared item status for one or more users.
accountId path · required — The external account number (int) or account ID GUID.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `1000`envelopes_not_shared_user_status query — This query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the results to only users that match the specified status: - `ActivationRequired`: Membership Activation required - `ActivationSent`: Membership activation sent to user - `Active`: User Membership is active - `Closed`: User Membership is closed - `Disabled`: User Membership is disabledfolder_ids query — A comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `folders`, at least one folder ID is required.item_type query — Specifies the type of shared item being requested. Valid values: - `envelopes`: Get information about envelope sharing between users. - `templates`: Get information about template sharing among users and groups. - `folders`: Get information about folder sharing among users and groups.search_text query — Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.shared query — A comma-separated list of sharing filters that specifies which users appear in the response. - `not_shared`: The response lists users who do not share items of `item_type` with the current user. - `shared_to`: The response lists users in `user_list` who are sharing items to current user. - `shared_from`: The response lists users in `user_list` who are sharing items from the current user. - `shared_to_and_from`: The response lists users in `user_list` who are sharing items to and from the current user. If the current user does not have administrative privileges, only the `shared_to` option is valid.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.user_ids query — A comma-separated list of user IDs for whom the shared item information is being requested.
PUT
/v2.1/accounts/{accountId}/shared_access
Reserved: Sets the shared access information for users.
accountId path · required — The external account number (int) or account ID GUID.item_type query — Specifies the type of shared item being set: - `envelopes`: Set envelope sharing between users. - `templates`: Set information about template sharing among users and groups. - `folders`: Get information about folder sharing among users and groups.preserve_existing_shared_access query — When **true,** preserve the existing shared access settings.user_ids query — A comma-separated list of IDs for users whose shared item access is being set.
GET
/v2.1/accounts/{accountId}/signatureProviders
Gets the available signature providers for an account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/signatures
Returns a list of stamps available in the account.
accountId path · required — The external account number (int) or account ID GUID.stamp_format query — The format of the stamp to return. Valid values: - `NameDateHanko` - `NameHanko` - `PlaceholderHanko`stamp_name query — The name associated with the stamps to return. This value can be a Japanese surname (up to 5 characters) or a purchase order ID.stamp_type query — The type of the stamps to return. Valid values: - `name_stamp` - `stamp` - `signature`
POST
/v2.1/accounts/{accountId}/signatures
Adds or updates one or more account stamps.
accountId path · required — The external account number (int) or account ID GUID.decode_only query
PUT
/v2.1/accounts/{accountId}/signatures
Updates an account stamp.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/signatures/{signatureId}
Deletes an account stamp.
accountId path · required — The external account number (int) or account ID GUID.signatureId path · required — The ID of the account stamp.
GET
/v2.1/accounts/{accountId}/signatures/{signatureId}
Returns information about the specified stamp.
accountId path · required — The external account number (int) or account ID GUID.signatureId path · required — The ID of the account stamp.
PUT
/v2.1/accounts/{accountId}/signatures/{signatureId}
Updates an account stamp by ID.
accountId path · required — The external account number (int) or account ID GUID.signatureId path · required — The ID of the account stamp.close_existing_signature query — When **true,** closes the current signature.
DELETE
/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
Deletes the image for a stamp.
accountId path · required — The external account number (int) or account ID GUID.imageType path · required — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`signatureId path · required — The ID of the account stamp.
PUT
/v2.1/accounts/{accountId}/users
Changes one or more users in the specified account.
accountId path · required — The external account number (int) or account ID GUID.allow_all_languages query
GET
/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
Returns the image for an account stamp.
accountId path · required — The external account number (int) or account ID GUID.imageType path · required — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`signatureId path · required — The ID of the account stamp.include_chrome query — When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.
PUT
/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
Sets a signature image, initials, or stamp.
accountId path · required — The external account number (int) or account ID GUID.imageType path · required — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`signatureId path · required — The ID of the account stamp.transparent_png query
DELETE
/v2.1/accounts/{accountId}/signing_groups
Deletes one or more signing groups.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/signing_groups
Gets a list of the Signing Groups in an account.
accountId path · required — The external account number (int) or account ID GUID.group_type query — Filters by the type of signing group. Valid values: * `sharedSigningGroup` * `privateSigningGroup` * `systemSigningGroup`include_users query — When **true,** the response includes the signing group members.
POST
/v2.1/accounts/{accountId}/signing_groups
Creates a signing group.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/signing_groups
Updates signing group names.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}
Gets information about a signing group.
accountId path · required — The external account number (int) or account ID GUID.signingGroupId path · required — The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).
PUT
/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}
Updates a signing group.
accountId path · required — The external account number (int) or account ID GUID.signingGroupId path · required — The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).
DELETE
/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
Deletes one or more members from a signing group.
accountId path · required — The external account number (int) or account ID GUID.signingGroupId path · required — The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note:** When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change t he default action of Needs to Sign to a different value, such as Receives a Copy.
GET
/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
Gets a list of members in a Signing Group.
accountId path · required — The external account number (int) or account ID GUID.signingGroupId path · required — The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note:** When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change t he default action of Needs to Sign to a different value, such as Receives a Copy.
PUT
/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
Adds members to a signing group.
accountId path · required — The external account number (int) or account ID GUID.signingGroupId path · required — The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note:** When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change t he default action of Needs to Sign to a different value, such as Receives a Copy.
GET
/v2.1/accounts/{accountId}/supported_languages
Gets the supported languages for envelope recipients.
accountId path · required — The external account number (int) or account ID GUID.
PUT
/v2.1/accounts/{accountId}/watermark
Update watermark information.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/tab_definitions
Gets a list of all account tabs.
accountId path · required — The external account number (int) or account ID GUID.custom_tab_only query — When **true,** only custom tabs are returned in the response.
POST
/v2.1/accounts/{accountId}/tab_definitions
Creates a custom tab.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/tab_definitions/{customTabId}
Deletes custom tab information.
accountId path · required — The external account number (int) or account ID GUID.customTabId path · required — The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
GET
/v2.1/accounts/{accountId}/tab_definitions/{customTabId}
Gets custom tab information.
accountId path · required — The external account number (int) or account ID GUID.customTabId path · required — The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
PUT
/v2.1/accounts/{accountId}/tab_definitions/{customTabId}
Updates custom tab information.
accountId path · required — The external account number (int) or account ID GUID.customTabId path · required — The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
GET
/v2.1/accounts/{accountId}/templates
Gets the list of templates.
accountId path · required — The external account number (int) or account ID GUID.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip.created_from_date query — Lists templates created on or after this date.created_to_date query — Lists templates modified before this date.folder_ids query — A comma-separated list of folder ID GUIDs.folder_types query — The type of folder to return templates for. Possible values are: - `templates`: Templates in the **My Templates** folder. Templates in the **Shared Templates** and **All Template** folders (if the request ID from and Admin) are excluded. - `templates_root`: Templates in the root level of the **My Templates** folder, but not in an actual folder. Note that the **My Templates** folder is not a real folder. - `recylebin`: Templates that have been deleted.from_date query — Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.include query — A comma-separated list of additional template attributes to include in the response. Valid values are: - `powerforms`: Includes details about the PowerForms associated with the templates. - `documents`: Includes information about template documents. - `folders`: Includes information about the folder that holds the template. - `favorite_template_status`: Includes the template `favoritedByMe` property. **Note:** You can mark a template as a favorite only in eSignature v2.1. - `advanced_templates`: Includes information about advanced templates. - `recipients`: Includes information about template recipients. - `custom_fields`: Includes information about template custom fields. - `notifications`: Includes information about the notification settings for templates.is_deleted_template_only query — When **true,** retrieves templates that have been permanently deleted. The default is **false.** **Note:** After you delete a template, you can see it in the `Deleted` bin in the UI for 24 hours. After 24 hours, the template is permanently deleted.is_download query — When **true,** downloads the templates listed in `template_ids` as a collection of JSON definitions in a single zip file. The `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The default is **false.** **Note:** This parameter only works when you specify a list of templates in the `template_ids` parameter.modified_from_date query — Lists templates modified on or after this date.modified_to_date query — Lists templates modified before this date.order query — Specifies the sort order of the search results. Valid values are: - `asc`: Ascending (A to Z) - `desc`: Descending (Z to A)order_by query — Specifies how the search results are listed. Valid values are: - `name`: template name - `modified`: date/time template was last modified - `used`: date/time the template was last used.search_fields query — A comma-separated list of additional template properties to search. - `sender`: Include sender name and email in the search. - `recipients`: Include recipient names and emails in the search. - `envelope`: Not used in template searches.search_text query — The text to use to search the names of templates. Limit: 48 characters.shared_by_me query — When **true,** the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.template_ids query — A comma-separated list of template IDs to download. This value is valid only when `is_download` is **true.**to_date query — 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 returned. **Note:** If this property is null, the value defaults to the current date.used_from_date query — Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.used_to_date query — End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.user_filter query — Filters the templates in the response. Valid values are: - `owned_by_me`: Results include only templates owned by the user. - `shared_with_me`: Results include only templates owned by the user. - `all`: Results include all templates owned or shared with the user.user_id query — The ID of the user.
POST
/v2.1/accounts/{accountId}/templates
Creates one or more templates.
accountId path · required — (Required) The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/templates/{templateId}
Gets a specific template associated with a specified account.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.include query — A comma-separated list of additional template attributes to include in the response. Valid values are: - `powerforms`: Includes information about PowerForms. - `tabs`: Includes information about tabs. - `documents`: Includes information about documents. - `favorite_template_status`: : Includes the template `favoritedByMe` property in the response. **Note:** You can mark a template as a favorite only in eSignature v2.1.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}
Updates an existing template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
Deletes envelope custom fields in a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
Gets the custom document fields from a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
Creates custom document fields in an existing template document.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
Updates envelope custom fields in a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/documents
Deletes documents from a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents
Gets a list of documents associated with a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.include_tabs query — Reserved for DocuSign.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/documents
Adds documents to a template document.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}
Gets PDF documents from a template.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.encrypt query — When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.show_changes query — When **true,** any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}
Updates a template document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.is_envelope_definition query
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
Deletes custom document fields from an existing template document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
Gets the custom document fields for a an existing template document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
Creates custom document fields in an existing template document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
Updates existing custom document fields in an existing template document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions
Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/watermark/preview
Get watermark preview.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages
Returns document page images based on input.
accountId path · required — (Required) The external account number (int) or account ID GUID.documentId path · required — (Required) The ID of the document.templateId path · required — (Required) The ID of the template.count query — The maximum number of results to return.dpi query — The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.max_height query — Sets the maximum height of the returned images in pixels.max_width query — Sets the maximum width of the returned images in pixels.nocache query — When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value.show_changes query — When **true,** changes display in the user interface.start_position query — The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}
Deletes a page from a document in an template.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.pageNumber path · required — The page number being accessed.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image
Gets a page image from a template for display.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.pageNumber path · required — The page number being accessed.templateId path · required — The ID of the template.dpi query — The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.max_height query — Sets the maximum height of the returned images in pixels.max_width query — Sets the maximum width of the returned images in pixels.show_changes query
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image
Rotates page image from a template for display.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.pageNumber path · required — The page number being accessed.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs
Returns tabs on the specified page.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.pageNumber path · required — The page number being accessed.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview
Creates a preview of the responsive version of a template document.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/workspaces
List Workspaces
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
Deletes tabs from a template.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
Returns tabs on a template.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.page_numbers query — 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`
POST
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
Adds tabs to a document in a template.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
Updates the tabs for a template.
accountId path · required — The external account number (int) or account ID GUID.documentId path · required — The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a `documentId` property that specifies the document on which to place the tab.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/html_definitions
Gets the Original HTML Definition used to generate the Responsive HTML for the template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/lock
Deletes a template lock.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/lock
Gets template lock information.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/lock
Locks a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/lock
Updates a template lock.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/notification
Gets template notification information.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/notification
Updates the notification structure for an existing template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/recipients
Deletes recipients from a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/workspaces
Create a Workspace
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/recipients
Gets recipient information from a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.include_anchor_tab_locations query — When **true** and `include_tabs` is set to **true,** all tabs with anchor tab properties are included in the response.include_extended query — When **true,** the extended properties are included in the response.include_tabs query — When **true,** the tab information associated with the recipient is included in the response.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/recipients
Adds tabs for a recipient.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.resend_envelope query — When **true,** resends the envelope to the recipients that you specify in the request body. Use this parameter to resend the envelope to a recipient who deleted the original email notification. **Note:** Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/recipients
Updates recipients in a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.resend_envelope query — When **true,** resends the envelope to the recipients that you specify in the request body. Use this parameter to resend the envelope to a recipient who deleted the original email notification. **Note:** Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility
Updates document visibility for template recipients
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}
Deletes the specified recipient file from a template.
accountId path · required — The external account number (int) or account ID GUID.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients
Deletes the bulk recipient list on a template.
accountId path · required — The external account number (int) or account ID GUID.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility
Returns document visibility for a template recipient
accountId path · required — The external account number (int) or account ID GUID.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility
Updates document visibility for a template recipient
accountId path · required — The external account number (int) or account ID GUID.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
Deletes the tabs associated with a recipient in a template.
accountId path · required — The external account number (int) or account ID GUID.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/workspaces/{workspaceId}
Delete Workspace
accountId path · required — The external account number (int) or account ID GUID.workspaceId path · required — The ID of the workspace.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
Gets the tabs information for a signer or sign-in-person recipient in a template.
accountId path · required — The external account number (int) or account ID GUID.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.templateId path · required — The ID of the template.include_anchor_tab_locations query — When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**include_metadata query — When **true,** the response includes metadata indicating which properties are editable.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
Adds tabs for a recipient.
accountId path · required — The external account number (int) or account ID GUID.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
Updates the tabs for a recipient.
accountId path · required — The external account number (int) or account ID GUID.recipientId path · required — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview
Creates a preview of the responsive versions of all of the documents associated with a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/views/edit
Gets a URL for a template edit view.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview
Creates a template recipient preview.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/workflow
Delete the workflow definition for a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/workflow
Returns the workflow definition for a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/workflow
Updates the workflow definition for a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
Deletes the scheduled sending rules for the template's workflow.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
Returns the scheduled sending rules for a template's workflow definition.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
Updates the scheduled sending rules for a template's workflow definition.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
POST
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps
Adds a new step to a template's workflow.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
Deletes a workflow step from an template's workflow definition.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.workflowStepId path · required — The ID of the workflow step.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
Returns a specified workflow step for a specified envelope.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.workflowStepId path · required — The ID of the workflow step.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
Updates a specified workflow step for a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.workflowStepId path · required — The ID of the workflow step.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
Deletes the delayed routing rules for the specified template workflow step.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.workflowStepId path · required — The ID of the workflow step.
GET
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
Returns the delayed routing rules for a template's workflow step definition.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.workflowStepId path · required — The ID of the workflow step.
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
Updates the delayed routing rules for a template's workflow step.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.workflowStepId path · required — The ID of the workflow step.
DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}
Removes a member group's sharing permissions for a template.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.templatePart path · required — Currently, the only defined part is **groups.**
PUT
/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}
Shares a template with a group.
accountId path · required — The external account number (int) or account ID GUID.templateId path · required — The ID of the template.templatePart path · required — Currently, the only defined part is **groups.**
GET
/v2.1/accounts/{accountId}/unsupported_file_types
Gets a list of unsupported file types.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/users
Closes one or more users in the account.
accountId path · required — The external account number (int) or account ID GUID.delete query — A list of groups to remove the user from. A comma-separated list of the following: - `Groups` - `PermissionSet` - `SigningGroupsEmail`
GET
/v2.1/accounts/{accountId}/users
Retrieves the list of users for the specified account.
accountId path · required — (Required) The external account number (int) or account ID GUID.additional_info query — When **true,** the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is **false.**alternate_admins_only querycount query — The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`domain_users_only queryemail query — Filters results based on the email address associated with the user that you want to return. **Note:** You can use either this parameter or the `email_substring` parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address.email_substring query — Filters results based on a fragment of an email address. For example, you could enter `gmail` to return all users who have Gmail addresses. **Note:** You do not use a wildcard character with this parameter. You can use either this parameter or the `email` parameter, but not both.group_id query — Filters results based on one or more group IDs.include_usersettings_for_csv query — When **true,** the response includes the `userSettings` object data in CSV format.login_status query — When **true,** the response includes the login status of each user.not_group_id query — Return user records excluding the specified group IDs.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.status query — Filters results by user account status. A comma-separated list of any of the following: * `ActivationRequired` * `ActivationSent` * `Active` * `Closed` * `Disabled`user_name_substring query — 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.
POST
/v2.1/accounts/{accountId}/users
Adds new users to the specified account.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/users/{userId}
Gets the user information for a specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.additional_info query — Setting this parameter has no effect in this operation.email query — Setting this parameter has no effect in this operation.
PUT
/v2.1/accounts/{accountId}/users/{userId}
Updates user information for the specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.allow_all_languages query
DELETE
/v2.1/accounts/{accountId}/users/{userId}/cloud_storage
Deletes the user authentication information for one or more cloud storage providers.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
GET
/v2.1/accounts/{accountId}/users/{userId}/cloud_storage
Get the Cloud Storage Provider configuration for the specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.redirectUrl query — The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.
POST
/v2.1/accounts/{accountId}/users/{userId}/cloud_storage
Configures the redirect URL information for one or more cloud storage providers for the specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
DELETE
/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}
Deletes the user authentication information for the specified cloud storage provider.
accountId path · required — The external account number (int) or account ID GUID.serviceId path · required — The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
GET
/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}
Gets the specified Cloud Storage Provider configuration for the User.
accountId path · required — The external account number (int) or account ID GUID.serviceId path · required — The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.redirectUrl query — The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.
GET
/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders
Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
accountId path · required — The external account number (int) or account ID GUID.serviceId path · required — The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.cloud_storage_folder_path query — A comma separated list of folder IDs included in the request.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `25`order query — The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.order_by query — The file attribute to use to sort the results. Valid values are: * `modified` * `name`search_text query — Use this parameter to search for specific text.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
GET
/v2.1/accounts/{accountId}/workspaces/{workspaceId}
Get Workspace
accountId path · required — The external account number (int) or account ID GUID.workspaceId path · required — The ID of the workspace.
GET
/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}
Gets a list of items from a cloud storage provider.
accountId path · required — The external account number (int) or account ID GUID.folderId path · required — The ID of the folder.serviceId path · required — The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.cloud_storage_folder_path query — The file path to a cloud storage folder.cloud_storage_folderid_plain query — A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder IDs as a comma-separated list.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `25`order query — The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.order_by query — The file attribute to use to sort the results. Valid values are: * `modified` * `name`search_text query — Use this parameter to search for specific text.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
DELETE
/v2.1/accounts/{accountId}/users/{userId}/custom_settings
Deletes custom user settings for a specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
GET
/v2.1/accounts/{accountId}/users/{userId}/custom_settings
Retrieves the custom user settings for a specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
PUT
/v2.1/accounts/{accountId}/users/{userId}/custom_settings
Adds or updates custom user settings for the specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
GET
/v2.1/accounts/{accountId}/users/{userId}/profile
Retrieves the user profile for a specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
PUT
/v2.1/accounts/{accountId}/users/{userId}/profile
Updates the user profile information for the specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
DELETE
/v2.1/accounts/{accountId}/users/{userId}/profile/image
Deletes the user profile image for the specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
GET
/v2.1/accounts/{accountId}/users/{userId}/profile/image
Retrieves the user profile image for the specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.encoding query — Reserved for DocuSign.
PUT
/v2.1/accounts/{accountId}/users/{userId}/profile/image
Updates the user profile image for a specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
GET
/v2.1/accounts/{accountId}/users/{userId}/settings
Gets the user account settings for a specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
PUT
/v2.1/accounts/{accountId}/users/{userId}/settings
Updates the user account settings for a specified user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.allow_all_languages query
PUT
/v2.1/accounts/{accountId}/workspaces/{workspaceId}
Update Workspace
accountId path · required — The external account number (int) or account ID GUID.workspaceId path · required — The ID of the workspace.
GET
/v2.1/accounts/{accountId}/users/{userId}/signatures
Retrieves a list of signature definitions for a user.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.stamp_type query — The type of stamps to return. Valid values are: - `signature`: Returns information about signature images only. This is the default value. - `stamp`: Returns information about eHanko and custom stamps only. - null
POST
/v2.1/accounts/{accountId}/users/{userId}/signatures
Adds user Signature and initials images to a Signature.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
PUT
/v2.1/accounts/{accountId}/users/{userId}/signatures
Adds/updates a user signature.
accountId path · required — The external account number (int) or account ID GUID.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
DELETE
/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
Removes removes signature information for the specified user.
accountId path · required — The external account number (int) or account ID GUID.signatureId path · required — The ID of the account stamp.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
GET
/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
Gets the user signature information for the specified user.
accountId path · required — The external account number (int) or account ID GUID.signatureId path · required — The ID of the account stamp.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
PUT
/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
Updates the user signature for a specified user.
accountId path · required — The external account number (int) or account ID GUID.signatureId path · required — The ID of the account stamp.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.close_existing_signature query — When **true,** closes the current signature.
DELETE
/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
Deletes the user initials image or the user signature image for the specified user.
accountId path · required — The external account number (int) or account ID GUID.imageType path · required — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`signatureId path · required — The ID of the account stamp.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
GET
/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
Retrieves the user initials image or the user signature image for the specified user.
accountId path · required — The external account number (int) or account ID GUID.imageType path · required — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`signatureId path · required — The ID of the account stamp.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.include_chrome query — When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.
PUT
/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
Updates the user signature image or user initials image for the specified user.
accountId path · required — The external account number (int) or account ID GUID.imageType path · required — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`signatureId path · required — The ID of the account stamp.userId path · required — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.transparent_png query
POST
/v2.1/accounts/{accountId}/views/console
Returns a URL to the DocuSign UI.
accountId path · required — The external account number (int) or account ID GUID.
GET
/v2.1/accounts/{accountId}/watermark
Get watermark information.
accountId path · required — The external account number (int) or account ID GUID.
DELETE
/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
Deletes files or sub-folders from a workspace.
accountId path · required — The external account number (int) or account ID GUID.folderId path · required — The ID of the folder.workspaceId path · required — The ID of the workspace.
GET
/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
List workspace folder contents
accountId path · required — The external account number (int) or account ID GUID.folderId path · required — The ID of the folder.workspaceId path · required — The ID of the workspace.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip.include_files query — When **true,** the response includes file information (in addition to folder information). The default is **false.**include_sub_folders query — When **true,** the response includes information about the sub-folders of the current folder. The default is **false.**include_thumbnails query — When **true,** the response returns thumbnails. The default is **false.**include_user_detail query — When **true,** the response includes extended details about the user. The default is **false.**start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.workspace_user_id query — If set, the response only includes results associated with the `userId` that you specify.
POST
/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files
Creates a workspace file.
accountId path · required — The external account number (int) or account ID GUID.folderId path · required — The ID of the folder.workspaceId path · required — The ID of the workspace.
GET
/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
Gets a workspace file
accountId path · required — The external account number (int) or account ID GUID.fileId path · required — The ID of the file.folderId path · required — The ID of the folder.workspaceId path · required — The ID of the workspace.is_download query — When **true,** the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The default is **false.**pdf_version query — When **true** the file is returned in PDF format.
PUT
/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
Update workspace file or folder metadata
accountId path · required — The external account number (int) or account ID GUID.fileId path · required — The ID of the file.folderId path · required — The ID of the folder.workspaceId path · required — The ID of the workspace.
GET
/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages
List File Pages
accountId path · required — The external account number (int) or account ID GUID.fileId path · required — The ID of the file.folderId path · required — The ID of the folder.workspaceId path · required — The ID of the workspace.count query — The maximum number of results to return. Use `start_position` to specify the number of results to skip.dpi query — The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.max_height query — Sets the maximum height of the returned images in pixels.max_width query — Sets the maximum width of the returned images in pixels.start_position query — The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
GET
/v2.1/billing_plans
Gets a list of available billing plans.
GET
/v2.1/billing_plans/{billingPlanId}
Gets billing plan details.
billingPlanId path · required — The ID of the billing plan being accessed.
GET
/v2.1/current_user/notary
Gets settings for a notary user.
include_jurisdictions query — When **true,** the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current user.
POST
/v2.1/current_user/notary
Registers the current user as a notary.
PUT
/v2.1/current_user/notary
Updates notary information for the current user.
GET
/v2.1/current_user/notary/journals
Gets notary jurisdictions for a user.
count query — The maximum number of results to return.search_text query — Use this parameter to search for specific text.start_position query — The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
GET
/v2.1/current_user/notary/jurisdictions
Returns a list of jurisdictions that the notary is registered in.
POST
/v2.1/current_user/notary/jurisdictions
Creates a jurisdiction object.
DELETE
/v2.1/current_user/notary/jurisdictions/{jurisdictionId}
Deletes the specified jurisdiction.
jurisdictionId path · required — The ID of the jurisdiction. The following jurisdictions are supported: - `5 - California` - `6 - Colorado` - `9 - Florida` - `10 - Georgia` - `12 - Idaho` - `13 - Illinois` - `14 - Indiana` - `15 - Iowa` - `17 - Kentucky` - `23 - Minnesota` - `25 - Missouri` - `30 - New Jersey` - `32 - New York` - `33 - North Carolina` - `35 - Ohio` - `37 - Oregon` - `38 - Pennsylvania` - `40 - South Carolina` - `43 - Texas` - `44 - Utah` - `47 - Washington` - `48 - West Virginia` - `49 - Wisconsin` - `62 - Florida Commissioner of Deeds`
GET
/v2.1/current_user/notary/jurisdictions/{jurisdictionId}
Gets a jurisdiction object for the current user. The user must be a notary.
jurisdictionId path · required — The ID of the jurisdiction. The following jurisdictions are supported: - `5 - California` - `6 - Colorado` - `9 - Florida` - `10 - Georgia` - `12 - Idaho` - `13 - Illinois` - `14 - Indiana` - `15 - Iowa` - `17 - Kentucky` - `23 - Minnesota` - `25 - Missouri` - `30 - New Jersey` - `32 - New York` - `33 - North Carolina` - `35 - Ohio` - `37 - Oregon` - `38 - Pennsylvania` - `40 - South Carolina` - `43 - Texas` - `44 - Utah` - `47 - Washington` - `48 - West Virginia` - `49 - Wisconsin` - `62 - Florida Commissioner of Deeds`
PUT
/v2.1/current_user/notary/jurisdictions/{jurisdictionId}
Updates the jurisdiction information about a notary.
jurisdictionId path · required — The ID of the jurisdiction. The following jurisdictions are supported: - `5 - California` - `6 - Colorado` - `9 - Florida` - `10 - Georgia` - `12 - Idaho` - `13 - Illinois` - `14 - Indiana` - `15 - Iowa` - `17 - Kentucky` - `23 - Minnesota` - `25 - Missouri` - `30 - New Jersey` - `32 - New York` - `33 - North Carolina` - `35 - Ohio` - `37 - Oregon` - `38 - Pennsylvania` - `40 - South Carolina` - `43 - Texas` - `44 - Utah` - `47 - Washington` - `48 - West Virginia` - `49 - Wisconsin` - `62 - Florida Commissioner of Deeds`
GET
/v2.1/current_user/password_rules
Gets membership account password rules.
DELETE
/v2.1/diagnostics/request_logs
Deletes the request log files.
GET
/v2.1/diagnostics/request_logs
Gets the API request logging log files.
encoding query — Reserved for DocuSign.
GET
/v2.1/diagnostics/request_logs/{requestLogId}
Gets a request logging log file.
requestLogId path · required — The ID of the log entry.
GET
/v2.1/diagnostics/settings
Gets the API request logging settings.
PUT
/v2.1/diagnostics/settings
Enables or disables API request logging for troubleshooting.
