@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Docusign eSignature REST API
@base https://www.docusign.net/restapi
@version v2.1
@auth ApiKey recipientId in path
@endpoints 405
@hint download_for_search
@toc service_information(1), v2.1(404)

@group service_information
@endpoint GET /service_information
@desc Retrieves the available REST API versions.
@returns(200) Successful response.
@errors {400: Error encountered.}

@endgroup

@group v2.1
@endpoint GET /v2.1
@desc Lists resources for REST version specified
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts
@desc Creates new accounts.
@optional {newAccountDefinition: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}
@desc Retrieves the account information for the specified account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {include_account_settings: any # When **true,** includes account settings in the response. The default value is **false.**, include_trial_eligibility: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}
@desc Deletes the specified account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {redact_user_data: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_charges
@desc Gets list of recurring and usage charges for the account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {include_charges: any # Specifies which billing charges to return. Valid values are:  * envelopes * seats}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_invoices
@desc Get a List of Billing Invoices
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {from_date: any # Specifies the date/time of the earliest invoice in the account to retrieve., to_date: any # Specifies the date/time of the latest invoice in the account to retrieve.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_invoices/{invoiceId}
@desc Retrieves a billing invoice.
@required {accountId: any # The external account number (int) or account ID GUID., invoiceId: any # The ID of the invoice.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_invoices_past_due
@desc Get a list of past due invoices.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_payments
@desc Gets payment information for one or more payments.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {from_date: any # Specifies the date/time of the earliest payment in the account to retrieve., to_date: any # Specifies the date/time of the latest payment in the account to retrieve.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/billing_payments
@desc Posts a payment to a past due invoice.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {billingPaymentRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_payments/{paymentId}
@desc Gets billing payment information for a specific payment.
@required {accountId: any # The external account number (int) or account ID GUID., paymentId: any # The ID of the payment.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_plan
@desc Get Account Billing Plan
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {include_credit_card_information: any # When **true,** payment information including credit card information will show in the return., include_downgrade_information: any, include_metadata: any # 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: any # When **true,** excludes successor information from the response., include_tax_exempt_id: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/billing_plan
@desc Updates an account billing plan.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {preview_billing_plan: any # When **true,** updates the account using a preview billing plan., billingPlanInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_plan/credit_card
@desc Get credit card information
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/billing_plan/downgrade
@desc Returns downgrade plan information for the specified account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/billing_plan/downgrade
@desc Queues downgrade billing plan request for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {downgradeBillingPlanInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/billing_plan/purchased_envelopes
@desc Reserved: Purchase additional envelopes.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {purchasedEnvelopesInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/brands
@desc Gets a list of brands.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {exclude_distributor_brand: any # When **true,** excludes distributor brand information from the response set., include_logos: any # When **true,** returns the logos associated with the brand.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/brands
@desc Creates one or more brand profiles for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {brand: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/brands
@desc Deletes one or more brand profiles.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {brandsRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/brands/{brandId}
@desc Gets information about a brand.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand.}
@optional {include_external_references: any # When **true,** the landing pages and links associated with the brand are included in the response., include_logos: any # When **true,** the URIs for the logos associated with the brand are included in the response.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/brands/{brandId}
@desc Updates an existing brand.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand.}
@optional {replace_brand: any # 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.**, brand: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/brands/{brandId}
@desc Deletes a brand.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/brands/{brandId}/file
@desc Exports a brand.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}
@desc Gets a brand logo.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand., logoType: any # The type of logo. Valid values are:  - `primary`  - `secondary`  - `email`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}
@desc Updates a brand logo.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand., logoType: any # The type of logo. Valid values are:  - `primary`  - `secondary`  - `email`, logoFileBytes: str(binary) # Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}
@desc Deletes a brand logo.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand., logoType: any # The type of logo. Valid values are:  - `primary`  - `secondary`  - `email`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/brands/{brandId}/resources
@desc Returns metadata about the branding resources for an account.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}
@desc Returns a branding resource file.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand., resourceContentType: any # The type of brand resource file to return. Valid values are:  - `sending` - `signing` - `email` - `signing_captive`}
@optional {langcode: any # The ISO 3166-1 alpha-2 codes for the languages that the brand supports., return_master: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}
@desc Updates a branding resource file.
@required {accountId: any # The external account number (int) or account ID GUID., brandId: any # The ID of the brand., resourceContentType: any # The type of brand resource file that you are updating. Valid values are:  - `sending` - `signing` - `email` - `signing_captive`, file.xml: any # Brand resource XML file.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/bulk_send_batch
@desc Returns a list of bulk send batch summaries.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {batch_ids: any # A comma-separated list of batch IDs to query., count: any # 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: any # The start date for a date range in UTC DateTime format., search_text: any # Use this parameter to search for specific text., start_position: any # 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: any # The kind of results to collect. Must be one of:  - all - failed - sent - queued, to_date: any # 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: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}
@desc Gets the status of a specific bulk send batch.
@required {accountId: any # The external account number (int) or account ID GUID., bulkSendBatchId: any # The batch ID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}
@desc Updates the name of a bulk send batch.
@required {accountId: any # The external account number (int) or account ID GUID., bulkSendBatchId: any # The batch ID.}
@optional {bulkSendBatchRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}
@desc Applies a bulk action to all envelopes from a specified bulk send.
@required {accountId: any # The external account number (int) or account ID GUID., bulkAction: any # The action to apply. Valid values: * `resend` * `correct` * `void`, bulkSendBatchId: any # The batch ID.}
@optional {bulkSendBatchActionRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes
@desc Gets envelopes from a specific bulk send batch.
@required {accountId: any # The external account number (int) or account ID GUID., bulkSendBatchId: any # The batch ID.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip.  Valid values: `1` to `1000`, include: any # When `recipients`, only envelopes with recipient nodes will be included in the response., order: any # The order in which to sort the results. Valid values are:  - Descending order: `desc` (default) - Ascending order: `asc`, order_by: any # The envelope attribute used to sort the results. Valid values are:  - `created` (default) - `completed` - `last_modified` - `sent` - `status` - `subject` - `status_changed`, search_text: any # Use this parameter to search for specific text., start_position: any # 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: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/bulk_send_lists
@desc Gets bulk send lists.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/bulk_send_lists
@desc Creates a bulk send list.
@required {accountId: any # The ID of the account.}
@optional {bulkSendingList: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
@desc Gets a specific bulk send list.
@required {accountId: any # The external account number (int) or account ID GUID., bulkSendListId: any # The GUID of the bulk send list. This property is created after you post a new bulk send list.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
@desc Updates a bulk send list.
@required {accountId: any # The external account number (int) or account ID GUID., bulkSendListId: any # The GUID of the bulk send list. This property is created after you post a new bulk send list.}
@optional {bulkSendingList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}
@desc Deletes a bulk send list.
@required {accountId: any # The external account number (int) or account ID GUID., bulkSendListId: any # The GUID of the bulk send list. This property is created after you post a new bulk send list.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send
@desc Creates a bulk send request.
@required {accountId: any # The external account number (int) or account ID GUID., bulkSendListId: any # The GUID of the bulk send list. This property is created after you post a new bulk send list.}
@optional {bulkSendRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test
@desc Creates a bulk send test.
@required {accountId: any # The external account number (int) or account ID GUID., bulkSendListId: any # The GUID of the bulk send list. This property is created after you post a new bulk send list.}
@optional {bulkSendRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/captive_recipients/{recipientPart}
@desc Deletes the signature for one or more captive recipient records.
@required {accountId: any # The external account number (int) or account ID GUID., recipientPart: any # Signature is the only supported value.}
@optional {captiveRecipientInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/chunked_uploads
@desc Initiate a new chunked upload.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {chunkedUploadRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
@desc Retrieves metadata about a chunked upload.
@required {accountId: any # The external account number (int) or account ID GUID., chunkedUploadId: any # The ID of the chunked upload.}
@optional {include: any # (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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
@desc Commit a chunked upload.
@required {accountId: any # (Required) The external account number (int) or account ID GUID., chunkedUploadId: any # (Required) The ID of the chunked upload to commit.}
@optional {action: any # (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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
@desc Deletes a chunked upload.
@required {accountId: any # The external account number (int) or account ID GUID., chunkedUploadId: any # The ID of the chunked upload.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}
@desc Add a chunk to an existing chunked upload.
@required {accountId: any # The external account number (int) or account ID GUID., chunkedUploadId: any # The ID of the chunked upload., chunkedUploadPartSeq: any # 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.}
@optional {chunkedUploadRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/connect
@desc Get Connect configuration information.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/connect
@desc Updates a specified Connect configuration.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {connectCustomConfiguration: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/connect
@desc Creates a Connect configuration.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {connectCustomConfiguration: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/connect/{connectId}
@desc Gets the details about a Connect configuration.
@required {accountId: any # The external account number (int) or account ID GUID., connectId: any # The ID of the custom Connect configuration being accessed.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/connect/{connectId}
@desc Deletes the specified Connect configuration.
@required {accountId: any # The external account number (int) or account ID GUID., connectId: any # The ID of the custom Connect configuration being accessed.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/connect/{connectId}/all/users
@desc Returns all users from the configured Connect service.
@required {accountId: any # The external account number (int) or account ID GUID., connectId: any # The ID of the custom Connect configuration being accessed.}
@optional {count: any # The maximum number of results to return., domain_users_only: any, email_substring: any # Filters returned user records by full email address or a substring of email address., start_position: any # 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: any # The status of the item., user_name_substring: any # Filters results based on a full or partial user name.  **Note:** When you enter a partial user name, you do not use a wildcard character.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/connect/{connectId}/users
@desc Returns users from the configured Connect service.
@required {accountId: any # The external account number (int) or account ID GUID., connectId: any # The ID of the custom Connect configuration being accessed.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip., email_substring: any # Filters returned user records by full email address or a substring of email address., list_included_users: any, start_position: any # 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: any # Filters the results by user status. You can specify a comma-separated list of the following statuses:  * ActivationRequired  * ActivationSent  * Active * Closed  * Disabled, user_name_substring: any # Filters results based on a full or partial user name.  **Note:** When you enter a partial user name, you do not use a wildcard character.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue
@desc Republishes Connect information for the specified envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/connect/envelopes/publish/historical
@desc Submits a batch of historical envelopes for republish to a webhook.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {connectHistoricalEnvelopeRepublish: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/connect/envelopes/retry_queue
@desc Republishes Connect information for multiple envelopes.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {connectFailureFilter: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/connect/failures
@desc Gets the Connect failure log information.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {from_date: any # The start date for a date range in UTC DateTime format.  **Note:** If this property is null, no date filtering is applied., to_date: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/connect/failures/{failureId}
@desc Deletes a Connect failure log entry.
@required {accountId: any # The external account number (int) or account ID GUID., failureId: any # The ID of the Connect post failure. Use `all` to delete all failures for the account.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/connect/logs
@desc Gets the Connect log.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {from_date: any # The start date for a date range in UTC DateTime format.  **Note:** If this property is null, no date filtering is applied., to_date: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/connect/logs
@desc Deletes a list of Connect log entries.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/connect/logs/{logId}
@desc Gets a Connect log entry.
@required {accountId: any # The external account number (int) or account ID GUID., logId: any # The ID of the Connect log entry.}
@optional {additional_info: any # When **true,** the response includes the `connectDebugLog` information.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/connect/logs/{logId}
@desc Deletes a specified Connect log entry.
@required {accountId: any # The external account number (int) or account ID GUID., logId: any # The ID of the Connect log entry. Use `all` to delete all entries for the account.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/connect/oauth
@desc Retrieves the Connect OAuth information for the account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/connect/oauth
@desc Updates the existing Connect OAuth configuration for the account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {connectOAuthConfig: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/connect/oauth
@desc Set up Connect OAuth for the specified account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {connectOAuthConfig: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/connect/oauth
@desc Delete the Connect OAuth configuration.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/consumer_disclosure
@desc Gets the default Electronic Record and Signature Disclosure for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {langCode: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}
@desc Gets the Electronic Record and Signature Disclosure for an account.
@required {accountId: any # The external account number (int) or account ID GUID., langCode: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}
@desc Updates the Electronic Record and Signature Disclosure for an account.
@required {accountId: any # The external account number (int) or account ID GUID., langCode: any # 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`.}
@optional {include_metadata: any # (Optional) When true, the response includes metadata indicating which properties are editable., consumerDisclosure: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/contacts
@desc Updates one or more contacts.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {contactModRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/contacts
@desc Add contacts to a contacts list.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {contactModRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/contacts
@desc Deletes multiple contacts from an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {contactModRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/contacts/{contactId}
@desc Gets one or more contacts.
@required {accountId: any # The external account number (int) or account ID GUID., contactId: any # The ID of a contact person in the account's address book.  **Note:** To return all contacts, omit this parameter. It is not required.}
@optional {cloud_provider: any # (Optional) The cloud provider from which to retrieve the contacts. Valid values are:  - `rooms` - `docusignCore` (default)}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/contacts/{contactId}
@desc Deletes a contact.
@required {accountId: any # The external account number (int) or account ID GUID., contactId: any # The ID of a contact person in the account's address book.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/custom_fields
@desc Gets a list of custom fields.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/custom_fields
@desc Creates an account custom field.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {apply_to_templates: any # (Optional) When **true,** the new custom field is applied to all of the templates on the account., customField: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/custom_fields/{customFieldId}
@desc Updates an account custom field.
@required {accountId: any # The external account number (int) or account ID GUID., customFieldId: any # The ID of the custom field.}
@optional {apply_to_templates: any, customField: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/custom_fields/{customFieldId}
@desc Deletes an account custom field.
@required {accountId: any # The external account number (int) or account ID GUID., customFieldId: any # The ID of the custom field.}
@optional {apply_to_templates: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes
@desc Search for specific sets of envelopes by using search filters.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {ac_status: any # Specifies the authoritative copy status for the envelopes. Valid values:  * `Unknown` * `Original` * `Transferred` * `AuthoritativeCopy` * `AuthoritativeCopyExportPending` * `AuthoritativeCopyExported` * `DepositPending` * `Deposited` * `DepositedEO` * `DepositFailed`, block: any # Reserved for Docusign., cdse_mode: any # Reserved for Docusign., continuation_token: any # Reserved for Docusign., count: any # The maximum number of results to return.  The maximum value is 1000. To get the next or previous set of envelopes, use `nextUri` or `previousUri` from the response., custom_field: any # 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: any # 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: any # Comma separated list of `envelopeId` values., exclude: any # Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`).   Valid values:  - `recipients` - `powerforms` - `folders`, folder_ids: any # 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: any # Returns the envelopes from folders of a specific type. Enter as a comma-separated list of the following values:  - `normal` - `inbox` - `sentitems` - `draft` - `templates`, from_date: any # 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`  If this property is not included, envelopes from the last two years will be returned.  [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_8601, from_to_status: any # This is the status type checked for in the `from_date`/`to_date` period. For example, if `Created` is specified, then envelopes created during the period are found. If `Changed` is specified, then envelopes that changed status during the period are returned. The default value is `Changed`.  Valid values: * `Changed` * `Voided` * `Created` * `Deleted` * `Sent` * `Delivered` * `Signed` * `Completed` * `Declined` * `TimedOut` * `Processing`, include: any # 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. - `payment_tabs`: The payment tabs associated with the envelope., include_purge_information: any # When **true,** information about envelopes that have been deleted is included in the response., intersecting_folder_ids: any # A comma-separated list of folders from which you want to get envelopes. Valid values:   - `normal` - `inbox` - `sentitems` - `draft` - `templates`, last_queried_date: any # Returns envelopes that were modified prior to the specified date and time.   Example: `2020-05-09T21:56:12.2500000Z`, order: any # Returns envelopes in either ascending (`asc`) or descending (`desc`) order., order_by: any # Sorts results according to a specific property. Valid values:  - `last_modified` - `action_required` - `created` - `completed` - `envelope_name` - `expire` - `sent` - `signer_list` - `status` - `subject` - `user_name` - `status_changed` - `last_modified`, powerformids: any # A comma-separated list of `PowerFormId` values., query_budget: any # The time in seconds that the query should run before returning data., requester_date_format: any, search_mode: any, search_text: any # Free text search criteria that you can use to filter the list of envelopes that is returned., start_position: any # 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: any # A comma-separated list of current envelope statuses to be included in the response. Valid values:  * `completed` * `created` * `declined` * `deleted` * `delivered` * `processing` * `sent` * `signed` * `timedout` * `voided`  The `any` value is equivalent to any status., to_date: any # 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_8601, transaction_ids: any # A comma-separated list of envelope transaction IDs.  Getting envelope status by transaction IDs is useful for offline signing situations to determine if an envelope was created or not. It can be used for the cases where a network connection was lost before the envelope status could be returned.  **Note:** Transaction IDs are only valid in the Docusign system for seven days., user_filter: any # 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: any # 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: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes
@desc Creates an envelope.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {cdse_mode: any # Reserved for Docusign., change_routing_order: any # When true, users can define the routing order of recipients while sending documents for signature., completed_documents_only: any # Reserved for Docusign., merge_roles_on_draft: any # 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., envelopeDefinition: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}
@desc Gets the status of a single envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {advanced_update: any # When **true,** envelope information can be added or modified., include: any # 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. - `prefill_tabs`: The pre-filled tabs 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., include_anchor_tab_locations: any # When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**, user_id: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}
@desc Send, void, or modify a draft envelope. Purge documents from a completed envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {advanced_update: any # When **true,** allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes., recycle_on_void: any, resend_envelope: any # When **true,** sends the specified envelope again., envelope: map # A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
@desc Returns a list of envelope attachments associated with a specified envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
@desc Adds one or more envelope attachments to a draft or in-process envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopeAttachmentsRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
@desc Deletes one or more envelope attachments from a draft envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopeAttachmentsRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}
@desc Retrieves an envelope attachment from an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., attachmentId: any # The unique identifier for the attachment., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}
@desc Updates an envelope attachment in a draft or in-process envelope.
@required {accountId: any # The external account number (int) or account ID GUID., attachmentId: any # The unique identifier for the attachment., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {attachment: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events
@desc Gets the envelope audit events for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {locale: any # The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript
@desc Gets a PDF transcript of all of the comments in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {encoding: any # (Optional) The encoding to use for the file.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
@desc Gets the custom field information for the specified envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
@desc Updates envelope custom fields in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {EnvelopeCustomFields: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
@desc Creates envelope custom fields for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {EnvelopeCustomFields: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
@desc Deletes envelope custom fields for draft and in-process envelopes.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {EnvelopeCustomFields: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields
@desc Returns sender fields for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields
@desc Updates sender fields for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {update_docgen_formfields_only: any # When **false** or omitted, the documents are updated.  When **true,** only the form fields are updated. The documents are unchanged., docGenFormFieldRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
@desc Gets a list of documents in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {documents_by_userid: any # 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_agreement_type: any, include_docgen_formfields: any # Reserved for Docusign., include_metadata: any # When **true,** the response includes metadata that indicates which properties the sender can edit., include_tabs: any # Reserved for Docusign., recipient_id: any # 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: any # 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).}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
@desc Adds one or more documents to an existing envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopeDefinition: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
@desc Deletes documents from a draft envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopeDefinition: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
@desc Retrieves a single document or all documents from an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {certificate: any # 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: any # 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: any # Reserved for Docusign., encrypt: any # 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: any # 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: any # 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: any # 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: any # 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: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
@desc Adds or replaces a document in an existing envelope.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, documentFileBytes: str(binary) # Updated document content.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields
@desc Gets the custom document fields from an  existing envelope document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields
@desc Updates existing custom document fields in an existing envelope document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {EnvelopeDocumentFields: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields
@desc Creates custom document fields in an existing envelope document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {EnvelopeDocumentFields: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields
@desc Deletes custom document fields from an existing envelope document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {EnvelopeDocumentFields: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions
@desc Retrieves the HTML definition used to generate a dynamically sized responsive document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # The GUID of the document.  Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744, envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages
@desc Returns document page images based on input.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {count: any # The maximum number of results to return., dpi: any # The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94., max_height: any # Sets the maximum height of the returned images in pixels., max_width: any # Sets the maximum width of the returned images in pixels., nocache: any # When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value., show_changes: any # When **true,** changes display in the user interface., start_position: any # The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}
@desc Deletes a page from a document in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, pageNumber: any # The page number being accessed.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image
@desc Gets a page image from an envelope for display.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, pageNumber: any # The page number being accessed.}
@optional {dpi: any # Sets the dots per inch (DPI) for the returned image., max_height: any # Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting., max_width: any # Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting., show_changes: any # When **true,** changes display in the user interface.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image
@desc Rotates page image from an envelope for display.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, pageNumber: any # The page number being accessed.}
@optional {pageRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs
@desc Returns tabs on the specified page.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, pageNumber: any # The page number being accessed.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview
@desc Creates a preview of the responsive version of a document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {documentHtmlDefinition: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
@desc Returns the tabs on a document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {include_metadata: any # When **true,** the response includes metadata indicating which properties are editable., page_numbers: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
@desc Updates the tabs for document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {tabs: map # A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
@desc Adds tabs to a document in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {tabs: map # A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
@desc Deletes tabs from a document in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {tabs: map # A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates
@desc Gets the templates associated with a document in an existing envelope.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {include: any # A comma-separated list that limits the results. Valid values are:  * `applied` * `matched`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates
@desc Adds templates to a document in an  envelope.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {preserve_template_recipient: any # 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., documentTemplateList: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}
@desc Deletes a template from a document in an existing envelope.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
@desc Gets the email setting overrides for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
@desc Updates the email setting overrides for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {emailSettings: map # A complex type that contains email settings.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
@desc Adds email setting overrides to an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {emailSettings: map # A complex type that contains email settings.}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings
@desc Deletes the email setting overrides for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data
@desc Returns envelope tab data for an existing envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions
@desc Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
@desc Gets envelope lock information.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
@desc Updates an envelope lock.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {lockRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
@desc Locks an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {lockRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock
@desc Deletes an envelope lock.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification
@desc Gets envelope notification information.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification
@desc Sets envelope notifications for an existing envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopeNotificationRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
@desc Gets the status of recipients for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {include_anchor_tab_locations: any # When **true** and `include_tabs` value is set to **true,** all tabs with anchor tab properties are included in the response., include_extended: any # When **true,** the extended properties are included in the response., include_metadata: any # Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates)., include_tabs: any # When **true,** the tab information associated with the recipient is included in the response.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
@desc Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {combine_same_order_recipients: any # When **true,** recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=fxo1578456612662.html), and is based on Recipient Role and Routing Order., offline_signing: any # Indicates if offline signing is enabled for the recipient when a network connection is unavailable., resend_envelope: any # 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., EnvelopeRecipients: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
@desc Adds one or more recipients to an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {resend_envelope: any # 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., EnvelopeRecipients: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
@desc Deletes recipients from an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {EnvelopeRecipients: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}
@desc Deletes a recipient from an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure
@desc Gets the default Electronic Record and Signature Disclosure for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {langCode: any # (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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}
@desc Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, langCode: any # (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: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {langCode: any # (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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility
@desc Returns document visibility for a recipient
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility
@desc Updates document visibility for a recipient
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {documentVisibilityList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token
@desc Creates a resource token for a sender to request ID Evidence data.
@required {accountId: any # The account ID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # The `recipientIdGuid`.}
@optional {token_scopes: any}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
@desc Gets the initials image for a user.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {include_chrome: any # Obsolete. The chrome is included in the image if it's present in the envelope.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
@desc Sets the initials image for an accountless signer.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature
@desc Gets signature information for a signer or sign-in-person recipient.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image
@desc Retrieve signature image information for a signer/sign-in-person recipient.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {include_chrome: any # Obsolete. The chrome is included in the image if it's present in the envelope.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image
@desc Sets the signature image for an accountless signer.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
@desc Gets the tabs information for a signer or sign-in-person recipient in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {include_anchor_tab_locations: any # When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**, include_metadata: any # When **true,** the response includes metadata indicating which properties are editable.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
@desc Updates the tabs for a recipient.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {EnvelopeRecipientTabs: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
@desc Adds tabs for a recipient.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {EnvelopeRecipientTabs: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
@desc Deletes the tabs associated with a recipient.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`.}
@optional {EnvelopeRecipientTabs: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review
@desc Create the link to the page for manually reviewing IDs.
@required {accountId: any # 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/s/document-item?bundleId=pik1583277475390&topicId=pmp1583277397015.html) page., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, recipientId: any # 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/s/document-item?bundleId=pik1583277475390&topicId=eya1583277454804.html) 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"         }   } ```}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility
@desc Updates document visibility for recipients
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {documentVisibilityList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview
@desc Creates a preview of the responsive versions of all of the documents in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {documentHtmlDefinition: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopesSharesRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob
@desc Reserved for Docusign.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob
@desc Reserved for Docusign.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates
@desc Gets templates used in an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {include: any # Filters the results by template type. Valid values: * `applied`: Returns the templates applied to an envelope. * `matching`: Returns the [matching templates](https://support.docusign.com/s/document-item?language=en_US&bundleId=jux1643235969954&topicId=far1578456612069.html&_LANG=enus) for an envelope.  The default value is `applied`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates
@desc Adds templates to an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {preserve_template_recipient: any # 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., documentTemplateList: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct
@desc Returns a URL to the envelope correction UI. Use after an envelope has been sent.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopeViewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct
@desc Revokes the correction view URL to the Envelope UI.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {correctViewRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit
@desc Returns a URL to the edit view UI. Use before an envelope has been sent.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopeViewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient
@desc Returns a URL to the recipient view UI. For signer recipients, returns the embedded signing view. Can also be used for other recipient types.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The ID of the draft envelope or template to preview.}
@optional {recipientViewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview
@desc Creates an envelope recipient preview.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {recipientPreviewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender
@desc Returns a URL to the sender view UI. Used before an envelope has been sent.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {envelopeViewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared
@desc Returns a URL to the shared recipient view UI for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {recipientViewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
@desc Returns the workflow definition for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
@desc Updates the workflow definition for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {workflow: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
@desc Delete the workflow definition for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
@desc Returns the scheduled sending rules for an envelope's workflow definition.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
@desc Updates the scheduled sending rules for an envelope's workflow.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {scheduledSending: map # An object that describes the settings for scheduled sending.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
@desc Deletes the scheduled sending rules for the envelope's workflow.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps
@desc Adds a new step to an envelope's workflow.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`}
@optional {workflowStep: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
@desc Returns a specified workflow step for a specified template.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, workflowStepId: any # The ID of the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
@desc Updates the specified workflow step for an envelope.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, workflowStepId: any # The ID of the workflow step.}
@optional {workflowStep: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
@desc Deletes a workflow step from an envelope's workflow definition.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, workflowStepId: any # The ID of the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
@desc Returns the delayed routing rules for an envelope's workflow step definition.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, workflowStepId: any # The ID of the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
@desc Updates the delayed routing rules for an envelope's workflow step definition.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, workflowStepId: any # The ID of the workflow step.}
@optional {delayedRouting: map # A complex element that specifies the delayed routing settings for the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
@desc Deletes the delayed routing rules for the specified envelope workflow step.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeId: any # The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`, workflowStepId: any # The ID of the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/status
@desc Gets envelope statuses for a set of envelopes.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {ac_status: any # Specifies the Authoritative Copy Status for the envelopes. Valid values:   - `Unknown` - `Original` - `Transferred` - `AuthoritativeCopy` - `AuthoritativeCopyExportPending` - `AuthoritativeCopyExported` - `DepositPending` - `Deposited` - `DepositedEO` - `DepositFailed`, block: any # When **true,** removes any results that match one of the provided `transaction_ids`., count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip., email: any # The email address of the sender., envelope_ids: any # The envelope IDs to include in the results.  The value of this property can be: * For the `GET` implementation of this method, use a comma-separated list of envelope IDs. * For the `PUT` implementation of this method, use the `request_body` value, and include the envelope IDs in the request body., from_date: any # 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: any # 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: any # 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: any # 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: any # 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: any # 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: any # 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., envelopeIdsRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/envelopes/transfer_rules
@desc Gets envelope transfer rules.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip., start_position: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules
@desc Changes the status of multiple envelope transfer rules.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {envelopeTransferRuleInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/envelopes/transfer_rules
@desc Creates an envelope transfer rule.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {envelopeTransferRuleRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}
@desc Changes the status of an envelope transfer rule.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeTransferRuleId: any # The ID of the envelope transfer rule. The system generates this ID when the rule is first created.}
@optional {envelopeTransferRule: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}
@desc Deletes an envelope transfer rule.
@required {accountId: any # The external account number (int) or account ID GUID., envelopeTransferRuleId: any # The ID of the envelope transfer rule. The system generates this ID when the rule is first created.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/favorite_templates
@desc Retrieves the list of favorite templates for the account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/favorite_templates
@desc Set one or more templates as account favorites.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {favoriteTemplatesInfo: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/favorite_templates
@desc Remove one or more templates from the account favorites.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {favoriteTemplatesInfo: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/folders
@desc Returns a list of the account's folders.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {count: any # The maximum number of results to return., include: any # 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: any # Indicates whether folder items are included in the response. If this parameter is omitted, the default is false., start_position: any # The zero-based index of the result from which to start returning results.  The default value is `0`., sub_folder_depth: any # 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: any # This parameter is deprecated as of version 2.1. Use `include` instead., user_filter: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/folders/{folderId}
@desc Gets information about items in a specified folder.
@required {accountId: any # The external account number (int) or account ID GUID., folderId: any # The ID of the folder.}
@optional {from_date: any # Reserved for Docusign., include_items: any # Indicates whether folder items are included in the response. If this parameter is omitted, the default is false., owner_email: any # Reserved for Docusign., owner_name: any # Reserved for Docusign., search_text: any # Reserved for Docusign., start_position: any # Reserved for Docusign., status: any # Reserved for Docusign., to_date: any # Reserved for Docusign.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/folders/{folderId}
@desc Moves a set of envelopes from their current folder to another folder.
@required {accountId: any # The external account number (int) or account ID GUID., folderId: any # The ID of the folder.}
@optional {foldersRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/groups
@desc Gets information about groups associated with the account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {count: any # 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: any # The type of group to return. Valid values:  * `AdminGroup` * `CustomGroup` * `EveryoneGroup`, include_usercount: any # 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: any # Filters the results of a GET request based on the text that you specify., start_position: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/groups
@desc Updates the group information for a group.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {groupInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/groups
@desc Creates one or more groups for the account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {groupInformation: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/groups
@desc Deletes an existing user group.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {groupInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/groups/{groupId}/brands
@desc Gets the brand information for a group.
@required {accountId: any # The external account number (int) or account ID GUID., groupId: any # The ID of the group.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/groups/{groupId}/brands
@desc Adds an existing brand to a group.
@required {accountId: any # The external account number (int) or account ID GUID., groupId: any # The ID of the group being accessed.}
@optional {brandsRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/groups/{groupId}/brands
@desc Deletes brand information from a group.
@required {accountId: any # The external account number (int) or account ID GUID., groupId: any # The ID of the group.}
@optional {brandsRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/groups/{groupId}/users
@desc Gets a list of users in a group.
@required {accountId: any # The external account number (int) or account ID GUID., groupId: any # The ID of the group being accessed.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip.  Valid values: `1` to `100` Default: `50`, start_position: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/groups/{groupId}/users
@desc Adds one or more users to an existing group.
@required {accountId: any # The external account number (int) or account ID GUID., groupId: any # The ID of the group being accessed.}
@optional {userInfoList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/groups/{groupId}/users
@desc Deletes one or more users from a group
@required {accountId: any # The external account number (int) or account ID GUID., groupId: any # The ID of the group being accessed.}
@optional {userInfoList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/identity_verification
@desc Retrieves the Identity Verification workflows available to an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {identity_verification_workflow_status: any # Filters the workflows returned according to status. Valid values:  - `active`: Only active workflows are returned. This is the default. - `deactivated`: Only deactivated workflows are returned. - `all`: All workflows are returned.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/payment_gateway_accounts
@desc List payment gateway accounts
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/permission_profiles
@desc Gets a list of permission profiles.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {include: any # 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`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/permission_profiles
@desc Creates a new permission profile for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {include: any # 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., permissionProfile: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
@desc Returns a permission profile for an account.
@required {accountId: any # The external account number (int) or account ID GUID., permissionProfileId: any # 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.}
@optional {include: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
@desc Updates a permission profile.
@required {accountId: any # The external account number (int) or account ID GUID., permissionProfileId: any # 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.}
@optional {include: any # 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., permissionProfile: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
@desc Deletes a permission profile from an account.
@required {accountId: any # The external account number (int) or account ID GUID., permissionProfileId: any # 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.}
@optional {move_users_to: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/powerforms
@desc Returns a list of PowerForms.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {count: any # The maximum number of results to return., from_date: any # The start date for a date range.  **Note:** If no value is provided, no date filtering is applied., order: any # The order in which to sort the results.  Valid values are:    * `asc`: Ascending order. * `desc`: Descending order., order_by: any # The file attribute to use to sort the results.  Valid values are:  - `sender` - `auth` - `used` - `remaining` - `lastused` - `status` - `type` - `templatename` - `created`, search_fields: any # 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: any # Use this parameter to search for specific text., start_position: any # The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image., to_date: any # The end date for a date range.  **Note:** If no value is provided, this property defaults to the current date.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/powerforms
@desc Creates a new PowerForm
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {powerForm: map # Information about any PowerForms that are included in the envelope.}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/powerforms
@desc Deletes one or more PowerForms.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {powerFormsRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}
@desc Returns a single PowerForm.
@required {accountId: any # The external account number (int) or account ID GUID., powerFormId: any # The ID of the PowerForm.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/powerforms/{powerFormId}
@desc Updates an existing PowerForm.
@required {accountId: any # The external account number (int) or account ID GUID., powerFormId: any # The ID of the PowerForm.}
@optional {powerForm: map # Information about any PowerForms that are included in the envelope.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/powerforms/{powerFormId}
@desc Deletes a PowerForm.
@required {accountId: any # The external account number (int) or account ID GUID., powerFormId: any # The ID of the PowerForm.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data
@desc Returns the data that users entered in a PowerForm.
@required {accountId: any # The external account number (int) or account ID GUID., powerFormId: any # The ID of the PowerForm.}
@optional {data_layout: any # The layout in which to return the PowerForm data.   For each of the following layouts, set the `Accept` header to the corresponding value.  Valid values are:  - `Native` (Set `Accept` header to `application/json`) - `Csv_Classic` (Set `Accept` header to `application/csv`) - `Csv_One_Envelope_Per_Line` (Set `Accept` header to `text/csv`) - `Xml_Classic` (Set `Accept` header to `application/xml`), from_date: any # The start date for a date range in UTC DateTime format.  **Note:** If this property is null, no date filtering is applied., to_date: any # The end date of a date range in UTC DateTime format. The default value is `UtcNow`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/powerforms/senders
@desc Gets PowerForm senders.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {start_position: any # The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/recipient_names
@desc Gets the recipient names associated with an email address.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {email: any # (Required) The email address for which you want to retrieve recipient names.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/seals
@desc Returns available seals for specified account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/search_folders/{searchFolderId}
@desc Deprecated. Use Envelopes: listStatusChanges.
@required {accountId: any # The external account number (int) or account ID GUID., searchFolderId: any # 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.}
@optional {all: any # Specifies that all envelopes that match the criteria are returned., count: any # 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: any # Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days., include_recipients: any # When **true,** the recipient information is returned in the response., order: any # Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order., order_by: any # Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`., start_position: any # 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: any # Specifies the end of the date range to return.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/settings
@desc Gets account settings information.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/settings
@desc Updates the account settings for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {accountSettingsInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/settings/bcc_email_archives
@desc Gets the BCC email archive configurations for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip., start_position: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/settings/bcc_email_archives
@desc Creates a BCC email archive configuration.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {bccEmailArchive: map # Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}
@desc Gets a BCC email archive configuration and its history.
@required {accountId: any # The external account number (int) or account ID GUID., bccEmailArchiveId: any # The ID of the BCC email archive configuration.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of items to skip., start_position: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}
@desc Deletes a BCC email archive configuration.
@required {accountId: any # The external account number (int) or account ID GUID., bccEmailArchiveId: any # The ID of the BCC email archive configuration.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/settings/enote_configuration
@desc Returns the configuration information for the eNote eOriginal integration.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/settings/enote_configuration
@desc Updates configuration information for the eNote eOriginal integration.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {eNoteConfiguration: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/settings/enote_configuration
@desc Deletes configuration information for the eNote eOriginal integration.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/settings/envelope_purge_configuration
@desc Gets the envelope purge configuration for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/settings/envelope_purge_configuration
@desc Sets the envelope purge configuration for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {envelopePurgeConfiguration: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/settings/notification_defaults
@desc Gets envelope notification defaults.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/settings/notification_defaults
@desc Updates envelope notification default settings.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {notificationDefaults: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/settings/password_rules
@desc Gets the password rules for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/settings/password_rules
@desc Updates the password rules for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {accountPasswordRules: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/settings/tabs
@desc Returns tab settings list for specified account
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/settings/tabs
@desc Modifies tab settings for specified account
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {tabAccountSettings: map # Account-wide tab settings.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/shared_access
@desc Reserved: Gets the shared item status for one or more users.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {count: any # 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: any # 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 disabled, folder_ids: any # 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: any # 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: any # Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string., shared: any # 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: any # 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: any # A comma-separated list of user IDs for whom the shared item information is being requested.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/shared_access
@desc Reserved: Sets the shared access information for users.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {item_type: any # 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: any # When **true,** preserve the existing shared access settings., user_ids: any # A comma-separated list of IDs for users whose shared item access is being set., accountSharedAccess: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/signatureProviders
@desc Gets the available signature providers for an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/signatures
@desc Returns a list of stamps available in the account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {stamp_format: any # The format of the stamp to return. Valid values: - `NameDateHanko` - `NameHanko` - `PlaceholderHanko`, stamp_name: any # 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: any # The type of the stamps to return. Valid values: - `name_stamp` - `stamp` - `signature`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/signatures
@desc Updates an account stamp.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {accountSignaturesInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/signatures
@desc Adds or updates one or more account stamps.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {decode_only: any, accountSignaturesInformation: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/signatures/{signatureId}
@desc Returns information about the specified stamp.
@required {accountId: any # The external account number (int) or account ID GUID., signatureId: any # The ID of the account stamp.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/signatures/{signatureId}
@desc Updates an account stamp by ID.
@required {accountId: any # The external account number (int) or account ID GUID., signatureId: any # The ID of the account stamp.}
@optional {close_existing_signature: any # When **true,** closes the current signature., accountSignatureDefinition: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/signatures/{signatureId}
@desc Deletes an account stamp.
@required {accountId: any # The external account number (int) or account ID GUID., signatureId: any # The ID of the account stamp.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
@desc Returns the image for an account stamp.
@required {accountId: any # The external account number (int) or account ID GUID., imageType: any # Specificies the type of image. Valid values:  - `stamp_image` - `signature_image` - `initials_image`, signatureId: any # The ID of the account stamp.}
@optional {include_chrome: any # When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
@desc Sets a signature image, initials, or stamp.
@required {accountId: any # The external account number (int) or account ID GUID., imageType: any # Specificies the type of image. Valid values:  - `stamp_image` - `signature_image` - `initials_image`, signatureId: any # The ID of the account stamp.}
@optional {transparent_png: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
@desc Deletes the image for a stamp.
@required {accountId: any # The external account number (int) or account ID GUID., imageType: any # Specificies the type of image. Valid values:  - `stamp_image` - `signature_image` - `initials_image`, signatureId: any # The ID of the account stamp.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/signing_groups
@desc Gets a list of the Signing Groups in an account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {group_type: any # Filters by the type of signing group. Valid values: * `sharedSigningGroup` * `privateSigningGroup` * `systemSigningGroup`, include_users: any # When **true,** the response includes the signing group members.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/signing_groups
@desc Updates signing group names.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {signingGroupInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/signing_groups
@desc Creates a signing group.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {signingGroupInformation: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/signing_groups
@desc Deletes one or more signing groups.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {signingGroupInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}
@desc Gets information about a signing group.
@required {accountId: any # The external account number (int) or account ID GUID., signingGroupId: any # The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}
@desc Updates a signing group.
@required {accountId: any # The external account number (int) or account ID GUID., signingGroupId: any # The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).}
@optional {signingGroup: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
@desc Gets a list of members in a Signing Group.
@required {accountId: any # The external account number (int) or account ID GUID., signingGroupId: any # The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).  **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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
@desc Adds members to a signing group.
@required {accountId: any # The external account number (int) or account ID GUID., signingGroupId: any # The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).  **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.}
@optional {signingGroupUsers: map # A complex type that contains information about users in the signing group.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
@desc Deletes  one or more members from a signing group.
@required {accountId: any # The external account number (int) or account ID GUID., signingGroupId: any # The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).  **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.}
@optional {signingGroupUsers: map # A complex type that contains information about users in the signing group.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/supported_languages
@desc Gets the supported languages for envelope recipients.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/tab_definitions
@desc Gets a list of all account tabs.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {custom_tab_only: any # When **true,** only custom tabs are returned in the response.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/tab_definitions
@desc Creates a custom tab.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {tabMetadata: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/tab_definitions/{customTabId}
@desc Gets custom tab information.
@required {accountId: any # The external account number (int) or account ID GUID., customTabId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/tab_definitions/{customTabId}
@desc Updates custom tab information.
@required {accountId: any # The external account number (int) or account ID GUID., customTabId: any # 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.}
@optional {tabMetadata: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/tab_definitions/{customTabId}
@desc Deletes custom tab information.
@required {accountId: any # The external account number (int) or account ID GUID., customTabId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates
@desc Gets the list of templates.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip.  **Note:** If the `count` parameter is not used, `listTemplates` has a default limit of 2,000 templates. If the account has more than 2,000 templates, `listTemplates` will return the first 2,000 templates. To retrieve more than 2,000 templates, repeat the API call, specifying `start_position` and `count` to control the number of templates retrieved., created_from_date: any # Lists templates created on or after this date., created_to_date: any # Lists templates modified before this date., folder_ids: any # A comma-separated list of folder ID GUIDs., folder_types: any # 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: any # 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: any # 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: any # 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: any # 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: any # Lists templates modified on or after this date., modified_to_date: any # Lists templates modified before this date., order: any # Specifies the sort order of the search results. Valid values are:  - `asc`: Ascending (A to Z) - `desc`: Descending (Z to A), order_by: any # 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: any # 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: any # The text to use to search the names of templates.  Limit: 48 characters., shared_by_me: any # When **true,** the response only includes templates shared by the user. When **false,** the response only returns template not shared by the user. If not specified, templates are returned whether or not they have been shared by the user., start_position: any # 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: any # A comma-separated list of template IDs to download. This value is valid only when `is_download` is **true.**, to_date: any # 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: any # 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: any # 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: any # 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 shared with the user.   - `all`:  Results include all templates owned or shared with the user., user_id: any # The ID of the user.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {templateAutoMatchList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates
@desc Creates one or more templates.
@required {accountId: any # (Required) The external account number (int) or account ID GUID.}
@optional {envelopeTemplate: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}
@desc Gets a specific template associated with a specified account.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {include: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}
@desc Updates an existing template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {envelopeTemplate: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}
@desc Shares a template with a group.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template., templatePart: any # Currently, the only defined part is **groups.**}
@optional {groupInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}
@desc Removes a member group's sharing permissions for a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template., templatePart: any # Currently, the only defined part is **groups.**}
@optional {groupInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
@desc Gets the custom document fields from a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
@desc Updates envelope custom fields in a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {templateCustomFields: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
@desc Creates custom document fields in an existing template document.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {templateCustomFields: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
@desc Deletes envelope custom fields in a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {templateCustomFields: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/documents
@desc Gets a list of documents associated with a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {include_agreement_type: any, include_tabs: any # Reserved for Docusign.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents
@desc Adds documents to a template document.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {envelopeDefinition: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents
@desc Deletes documents from a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {envelopeDefinition: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}
@desc Gets PDF documents from a template.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {encrypt: any # 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., file_type: any, show_changes: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}
@desc Updates a template document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {is_envelope_definition: any, envelopeDefinition: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
@desc Gets the custom document fields for a an existing template document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
@desc Updates existing custom document fields in an existing template document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {documentFieldsInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
@desc Creates custom document fields in an existing template document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {documentFieldsInformation: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
@desc Deletes custom document fields from an existing template document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {documentFieldsInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions
@desc Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages
@desc Returns document page images based on input.
@required {accountId: any # (Required) The external account number (int) or account ID GUID., documentId: any # (Required) The ID of the document., templateId: any # (Required) The ID of the template.}
@optional {count: any # The maximum number of results to return., dpi: any # The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94., max_height: any # Sets the maximum height of the returned images in pixels., max_width: any # Sets the maximum width of the returned images in pixels., nocache: any # When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value., show_changes: any # When **true,** changes display in the user interface., start_position: any # The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}
@desc Deletes a page from a document in an template.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The page number being accessed., templateId: any # The ID of the template.}
@optional {pageRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image
@desc Gets a page image from a template for display.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The page number being accessed., templateId: any # The ID of the template.}
@optional {dpi: any # The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94., max_height: any # Sets the maximum height of the returned images in pixels., max_width: any # Sets the maximum width of the returned images in pixels., show_changes: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image
@desc Rotates page image from a template for display.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The page number being accessed., templateId: any # The ID of the template.}
@optional {pageRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs
@desc Returns tabs on the specified page.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The page number being accessed., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview
@desc Creates a preview of the responsive version of a template document.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {documentHtmlDefinition: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
@desc Returns tabs on a template.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {page_numbers: any # 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`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
@desc Updates the tabs for a template.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {templateTabs: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
@desc Adds tabs to a document in a template.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {templateTabs: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
@desc Deletes tabs from a template.
@required {accountId: any # The external account number (int) or account ID GUID., documentId: any # 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: any # The ID of the template.}
@optional {templateTabs: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/html_definitions
@desc Gets the Original HTML Definition used to generate the Responsive HTML for the template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/lock
@desc Gets template lock information.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/lock
@desc Updates a template lock.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {lockRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/lock
@desc Locks a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {lockRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/lock
@desc Deletes a template lock.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {lockRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/notification
@desc Gets template notification information.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/notification
@desc Updates the notification  structure for an existing template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {templateNotificationRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients
@desc Gets recipient information from a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {include_anchor_tab_locations: any # When **true** and `include_tabs` is set to **true,** all tabs with anchor tab properties are included in the response., include_extended: any # When **true,** the extended properties are included in the response., include_tabs: any # When **true,** the tab information associated with the recipient is included in the response.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients
@desc Updates recipients in a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {resend_envelope: any # 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., templateRecipients: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients
@desc Adds tabs for a recipient.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {resend_envelope: any # 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., templateRecipients: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients
@desc Deletes recipients from a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {templateRecipients: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}
@desc Deletes the specified recipient file from a template.
@required {accountId: any # The external account number (int) or account ID GUID., recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`., templateId: any # The ID of the template.}
@optional {templateRecipients: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility
@desc Returns document visibility for a template recipient
@required {accountId: any # The external account number (int) or account ID GUID., recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility
@desc Updates document visibility for a template recipient
@required {accountId: any # The external account number (int) or account ID GUID., recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`., templateId: any # The ID of the template.}
@optional {templateDocumentVisibilityList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
@desc Gets the tabs information for a signer or sign-in-person recipient in a template.
@required {accountId: any # The external account number (int) or account ID GUID., recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`., templateId: any # The ID of the template.}
@optional {include_anchor_tab_locations: any # When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**, include_metadata: any # When **true,** the response includes metadata indicating which properties are editable.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
@desc Updates the tabs for a recipient.
@required {accountId: any # The external account number (int) or account ID GUID., recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`., templateId: any # The ID of the template.}
@optional {templateTabs: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
@desc Adds tabs for a recipient.
@required {accountId: any # The external account number (int) or account ID GUID., recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`., templateId: any # The ID of the template.}
@optional {templateTabs: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
@desc Deletes the tabs associated with a recipient in a template.
@required {accountId: any # The external account number (int) or account ID GUID., recipientId: any # A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`., templateId: any # The ID of the template.}
@optional {templateTabs: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility
@desc Updates document visibility for template recipients
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {templateDocumentVisibilityList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview
@desc Creates a preview of the responsive versions of all of the documents associated with a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {documentHtmlDefinition: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/views/edit
@desc Gets a URL for a template edit view.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {templateViewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview
@desc Creates a template recipient preview.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {recipientPreviewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow
@desc Returns the workflow definition for a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow
@desc Updates the workflow definition for a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {workflow: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow
@desc Delete the workflow definition for a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
@desc Returns the scheduled sending rules for a template's workflow definition.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
@desc Updates the scheduled sending rules for a template's workflow definition.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {scheduledSending: map # An object that describes the settings for scheduled sending.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
@desc Deletes the scheduled sending rules for the template's workflow.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps
@desc Adds a new step to a template's workflow.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template.}
@optional {workflowStep: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
@desc Returns a specified workflow step for a specified envelope.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template., workflowStepId: any # The ID of the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
@desc Updates a specified workflow step for a template.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template., workflowStepId: any # The ID of the workflow step.}
@optional {workflowStep: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
@desc Deletes a workflow step from an template's workflow definition.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template., workflowStepId: any # The ID of the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
@desc Returns the delayed routing rules for a template's workflow step definition.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template., workflowStepId: any # The ID of the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
@desc Updates the delayed routing rules for a template's workflow step.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template., workflowStepId: any # The ID of the workflow step.}
@optional {delayedRouting: map # A complex element that specifies the delayed routing settings for the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
@desc Deletes the delayed routing rules for the specified template workflow step.
@required {accountId: any # The external account number (int) or account ID GUID., templateId: any # The ID of the template., workflowStepId: any # The ID of the workflow step.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/templates/auto_match
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {templateAutoMatchList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/unsupported_file_types
@desc Gets a list of unsupported file types.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users
@desc Retrieves the list of users for the specified account. You can filter the users list to get specific users.
@required {accountId: any # (Required) The external account number (int) or account ID GUID.}
@optional {additional_info: any # 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: any # When **true,** returns only alternate administrators. These users are not administrators but will be set as such if all administrator memberships are closed. The default value is **false.**, count: any # 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: any # When **true,** return only users in [domains](https://support.docusign.com/s/document-item?rsc_301=&bundleId=rrf1583359212854&topicId=jub1589318086105.html) claimed by your organization. The default value is **false.**, email: any # 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: any # Filters results based on a fragment of an email address. For example, you could enter `gmail.com` 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: any # Filters results based on one or more group IDs., include_license: any, include_usersettings_for_csv: any # When **true,** the response includes the `userSettings` object data in CSV format., login_status: any # When **true,** the response includes the login status of each user., not_group_id: any # Return user records excluding the specified group IDs., start_position: any # 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: any # Filters results by user account status. A comma-separated list of any of the following:  * `ActivationRequired` * `ActivationSent` * `Active` * `Closed` * `Disabled`, user_name_substring: any # Filters the user records returned by the user name or a sub-string of user name.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users
@desc Changes one or more users in the specified account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {allow_all_languages: any, userInformationList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/users
@desc Adds new users to the specified account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {newUsersDefinition: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users
@desc Closes one or more users in the account.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {delete: any # A list of groups to remove the user from. A comma-separated list of the following:  - `Groups` - `PermissionSet` - `SigningGroupsEmail`, userInfoList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}
@desc Gets the user information for a specified user using a userId (GUID). To find a user based on their email address, use the list endpoint.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {additional_info: any # Setting this parameter has no effect in this operation., email: any # Setting this parameter has no effect in this operation., include_license: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}
@desc Updates user information for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {allow_all_languages: any, userInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/users/{userId}/authorization
@desc Creates a user authorization.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # The ID of the principal user.}
@optional {userAuthorizationCreateRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}
@desc Returns the user authorization for a given authorization ID.
@required {accountId: any # The external account number (int) or account ID GUID., authorizationId: any # The ID of the user authorization., userId: any # The ID of the principal user.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}
@desc Updates the start or end date for a user authorization.
@required {accountId: any # The external account number (int) or account ID GUID., authorizationId: any # The ID of the user authorization., userId: any # The ID of the principal user.}
@optional {userAuthorizationUpdateRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}
@desc Deletes the user authorization.
@required {accountId: any # The external account number (int) or account ID GUID., authorizationId: any # The ID of the user authorization., userId: any # The ID of the principal user.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/authorizations
@desc Returns the authorizations for which the specified user is the principal user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # The ID of the principal user.}
@optional {active_only: any # When **true,** return only active authorizations. The default value is **true.**, count: any # The maximum number of results to return., email_substring: any # Filters returned user records by full email address or a substring of email address., include_closed_users: any # When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when `active_only` is **false.**, permissions: any # Filters results by authorization permission. Valid values: * `Send` * `Manage` * `Sign`, start_position: any # The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image., user_name_substring: any # Filters results based on a full or partial user name.  **Note:** When you enter a partial user name, you do not use a wildcard character.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/users/{userId}/authorizations
@desc Create or update multiple user authorizations.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # The ID of the principal user.}
@optional {userAuthorizationsRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users/{userId}/authorizations
@desc Delete multiple user authorizations.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # The ID of the principal user.}
@optional {userAuthorizationsDeleteRequest: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/authorizations/agent
@desc Returns the authorizations for which the specified user is the agent user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # The user who is acting as the agent.}
@optional {active_only: any # When **true,** only active users are returned. The default value is **false.**, count: any # The maximum number of results to return., email_substring: any # Filters returned user records by full email address or a substring of email address., include_closed_users: any # When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when `active_only` is **false.**, permissions: any, start_position: any # The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image., user_name_substring: any # Filters results based on a full or partial user name.  **Note:** When you enter a partial user name, you do not use a wildcard character.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage
@desc Get the Cloud Storage Provider configuration for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {redirectUrl: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/users/{userId}/cloud_storage
@desc Configures the redirect URL information  for one or more cloud storage providers for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {cloudStorageProviders: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage
@desc Deletes the user authentication information for one or more cloud storage providers.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {cloudStorageProviders: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}
@desc Gets the specified Cloud Storage Provider configuration for the User.
@required {accountId: any # The external account number (int) or account ID GUID., serviceId: any # The ID of the service to access.   Valid values are the service name ("Box") or the numerical serviceId ("4136")., userId: any # 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.}
@optional {redirectUrl: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}
@desc Deletes the user authentication information for the specified cloud storage provider.
@required {accountId: any # The external account number (int) or account ID GUID., serviceId: any # The ID of the service to access.   Valid values are the service name ("Box") or the numerical serviceId ("4136")., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders
@desc Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
@required {accountId: any # The external account number (int) or account ID GUID., serviceId: any # The ID of the service to access.   Valid values are the service name ("Box") or the numerical serviceId ("4136")., userId: any # 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.}
@optional {cloud_storage_folder_path: any # A comma separated list of folder IDs included in the request., count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip.  Default: `25`, order: any # The order in which to sort the results.  Valid values are:    * `asc`: Ascending order. * `desc`: Descending order., order_by: any # The file attribute to use to sort the results.  Valid values are:   * `modified` * `name`, search_text: any # Use this parameter to search for specific text., start_position: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}
@desc Gets a list of items from a cloud storage provider.
@required {accountId: any # The external account number (int) or account ID GUID., folderId: any # The ID of the folder., serviceId: any # The ID of the service to access.   Valid values are the service name ("Box") or the numerical serviceId ("4136")., userId: any # 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.}
@optional {cloud_storage_folder_path: any # The file path to a cloud storage folder., cloud_storage_folderid_plain: any # 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: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip.  Default: `25`, order: any # The order in which to sort the results.  Valid values are:    * `asc`: Ascending order. * `desc`: Descending order., order_by: any # The file attribute to use to sort the results.  Valid values are:   * `modified` * `name`, search_text: any # Use this parameter to search for specific text., sky_drive_skip_token: any, start_position: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/custom_settings
@desc Retrieves the custom user settings for a specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}/custom_settings
@desc Adds or updates custom user settings for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {customSettingsInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users/{userId}/custom_settings
@desc Deletes custom user settings for a specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {customSettingsInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/profile
@desc Retrieves the user profile for a specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}/profile
@desc Updates the user profile information for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {userProfile: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/profile/image
@desc Retrieves the user profile image for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {encoding: any # Reserved for Docusign.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}/profile/image
@desc Updates the user profile image for a specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users/{userId}/profile/image
@desc Deletes the user profile image for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/settings
@desc Gets the user account settings for a specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}/settings
@desc Updates the user account settings for a specified user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {allow_all_languages: any, userSettingsInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/signatures
@desc Retrieves a list of signature definitions for a user.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {stamp_type: any # 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}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}/signatures
@desc Adds/updates a user signature.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {userSignaturesInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/users/{userId}/signatures
@desc Adds user Signature and initials images to a Signature.
@required {accountId: any # The external account number (int) or account ID GUID., userId: any # 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.}
@optional {userSignaturesInformation: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
@desc Gets the user signature information for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., signatureId: any # The ID of the account stamp., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
@desc Updates the user signature for a specified user.
@required {accountId: any # The external account number (int) or account ID GUID., signatureId: any # The ID of the account stamp., userId: any # 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.}
@optional {close_existing_signature: any # When **true,** closes the current signature., userSignatureDefinition: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
@desc Removes removes signature information for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., signatureId: any # The ID of the account stamp., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
@desc Retrieves the user initials image or the  user signature image for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., imageType: any # Specificies the type of image. Valid values:  - `stamp_image` - `signature_image` - `initials_image`, signatureId: any # The ID of the account stamp., userId: any # 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.}
@optional {include_chrome: any # When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
@desc Updates the user signature image or user initials image for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., imageType: any # Specificies the type of image. Valid values:  - `stamp_image` - `signature_image` - `initials_image`, signatureId: any # The ID of the account stamp., userId: any # 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., imageBytes: str(binary) # Updated image content.}
@optional {transparent_png: any}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
@desc Deletes the user initials image or the  user signature image for the specified user.
@required {accountId: any # The external account number (int) or account ID GUID., imageType: any # Specificies the type of image. Valid values:  - `stamp_image` - `signature_image` - `initials_image`, signatureId: any # The ID of the account stamp., userId: any # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/views/console
@desc Returns a URL to the Docusign eSignature web application.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {consoleViewRequest: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/watermark
@desc Get watermark information.
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/watermark
@desc Update watermark information.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {watermark: map # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/watermark/preview
@desc Get watermark preview.
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {watermark: map # 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.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/workspaces
@desc List Workspaces
@required {accountId: any # The external account number (int) or account ID GUID.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/workspaces
@desc Create a Workspace
@required {accountId: any # The external account number (int) or account ID GUID.}
@optional {workspace: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}
@desc Get Workspace
@required {accountId: any # The external account number (int) or account ID GUID., workspaceId: any # The ID of the workspace.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}
@desc Update Workspace
@required {accountId: any # The external account number (int) or account ID GUID., workspaceId: any # The ID of the workspace.}
@optional {workspace: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}
@desc Delete Workspace
@required {accountId: any # The external account number (int) or account ID GUID., workspaceId: any # The ID of the workspace.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
@desc List workspace folder contents
@required {accountId: any # The external account number (int) or account ID GUID., folderId: any # The ID of the folder., workspaceId: any # The ID of the workspace.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip., include_files: any # When **true,** the response includes file information (in addition to folder information). The default is **false.**, include_sub_folders: any # When **true,** the response includes information about the sub-folders of the current folder. The default is **false.**, include_thumbnails: any # When **true,** the response returns thumbnails.  The default is **false.**, include_user_detail: any # When **true,** the response includes extended details about the user. The default is **false.**, start_position: any # 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: any # If set, the response only includes results associated with the `userId` that you specify.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
@desc Deletes files or sub-folders from a workspace.
@required {accountId: any # The external account number (int) or account ID GUID., folderId: any # The ID of the folder., workspaceId: any # The ID of the workspace.}
@optional {workspaceItemList: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files
@desc Creates a workspace file.
@required {accountId: any # The external account number (int) or account ID GUID., folderId: any # The ID of the folder., workspaceId: any # The ID of the workspace.}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
@desc Gets a workspace file
@required {accountId: any # The external account number (int) or account ID GUID., fileId: any # The ID of the file., folderId: any # The ID of the folder., workspaceId: any # The ID of the workspace.}
@optional {is_download: any # 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: any # When **true** the file is returned in PDF format.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
@desc Update workspace file or folder metadata
@required {accountId: any # The external account number (int) or account ID GUID., fileId: any # The ID of the file., folderId: any # The ID of the folder., workspaceId: any # The ID of the workspace.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages
@desc List File Pages
@required {accountId: any # The external account number (int) or account ID GUID., fileId: any # The ID of the file., folderId: any # The ID of the folder., workspaceId: any # The ID of the workspace.}
@optional {count: any # The maximum number of results to return.  Use `start_position` to specify the number of results to skip., dpi: any # The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94., max_height: any # Sets the maximum height of the returned images in pixels., max_width: any # Sets the maximum width of the returned images in pixels., start_position: any # 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`.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/accounts/provisioning
@desc Retrieves the account provisioning information for the account.
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/billing_plans
@desc Gets a list of available billing plans.
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/billing_plans/{billingPlanId}
@desc Gets billing plan details.
@required {billingPlanId: any # The ID of the billing plan being accessed.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/current_user/notary
@desc Gets settings for a  notary user.
@optional {include_jurisdictions: any # When **true,** the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current user.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/current_user/notary
@desc Updates notary information for the current user.
@optional {notary: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/current_user/notary
@desc Registers the current user as a notary.
@optional {notary: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/current_user/notary/journals
@desc Gets notary jurisdictions for a user.
@optional {count: any # The maximum number of results to return., search_text: any # Use this parameter to search for specific text., start_position: any # The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/current_user/notary/jurisdictions
@desc Returns a list of jurisdictions that the notary is registered in.
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint POST /v2.1/current_user/notary/jurisdictions
@desc Creates a jurisdiction object.
@optional {notaryJurisdiction: map}
@returns(201) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/current_user/notary/jurisdictions/{jurisdictionId}
@desc Gets a jurisdiction object for the current user. The user must be a notary.
@required {jurisdictionId: any # 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`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/current_user/notary/jurisdictions/{jurisdictionId}
@desc Updates the jurisdiction information about a notary.
@required {jurisdictionId: any # 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`}
@optional {notaryJurisdiction: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/current_user/notary/jurisdictions/{jurisdictionId}
@desc Deletes the specified jurisdiction.
@required {jurisdictionId: any # 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`}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/current_user/password_rules
@desc Gets membership account password rules.
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/diagnostics/request_logs
@desc Gets the API request logging log files.
@optional {encoding: any # Reserved for Docusign.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint DELETE /v2.1/diagnostics/request_logs
@desc Deletes the request log files.
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/diagnostics/request_logs/{requestLogId}
@desc Gets a request logging log file.
@required {requestLogId: any # The ID of the log entry.}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint GET /v2.1/diagnostics/settings
@desc Gets the API request logging settings.
@returns(200) Successful response.
@errors {400: Error encountered.}

@endpoint PUT /v2.1/diagnostics/settings
@desc Enables or disables API request logging for troubleshooting.
@optional {diagnosticsSettingsInformation: map}
@returns(200) Successful response.
@errors {400: Error encountered.}

@endgroup

@end