Skip to main content

DocuSign (JWT)

Send and sign documents with DocuSign using JWT Grant authentication.

DocuSign (JWT) Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 632 actions:

ActionPurposeParameters
esignature/get_service_informationRetrieves the available REST API versions. Docusign Production system: https://www.docusign.net/restapi/service_information Docusign Demo system: https://demo.docusign.net/restapi/service_information You do not need an integration key to view the REST API versions and resources.No parameters
esignature/get_v2_1Retrieves the base resources available for the eSignature REST API. You do not need an integrator key to view the REST API versions and resources.No parameters
esignature/post_v2_1_accountsCreates new Docusign accounts. You can use this method to create a single account or up to 100 accounts at a time. Note: This method is restricted to partner integrations. You must work with Docusign Professional Services or Docusign Business Development, who will provide you with the Distributor Code and Distributor Password that you need to include in the request body. When creating a single account, the body of the request is a newAccountRequestnewAccountRequest object. Example: 'nedata: {
. accountName (string)
. accountSettings
. addressInformation
. creditCardInformation
. directDebitProcessorInformation
. distributorCode (string)
. distributorPassword (string)
. enablePreAuth (string)
. envelopePartitionId (string)
. initialUser
. paymentMethod (string)
. paymentProcessor (string)
. paymentProcessorInformation
. planInformation
. processPayment (string)
. referralInformation
. socialAccountInformation
. taxExemptId (string)
} (object) required
esignature/get_v2_1_accounts_by_account_idRetrieves the account information for the specified account.accountId (string)
include_account_settings (string)
include_trial_eligibility (string)
esignature/delete_v2_1_accounts_by_account_idThis closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by Docusign.accountId (string)
redact_user_data (string)
esignature/get_v2_1_accounts_by_account_id_billing_chargesRetrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administratoraccountId (string)
include_charges (string)
esignature/get_v2_1_accounts_by_account_id_billing_invoicesRetrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administratoraccountId (string)
from_date (string)
to_date (string)
esignature/get_v2_1_accounts_by_account_id_billing_invoices_by_invoice_idRetrieves the specified invoice. Note: If the pdfAvailable property in the response is set to true, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the Accept property in the header to Accept: application/pdf. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the aaccountId (string)
invoiceId (string)
esignature/get_v2_1_accounts_by_account_id_billing_invoices_past_dueReturns a list past due invoices for the account and notes if payment can be made through the REST API. Privileges Required: account administratoraccountId (string)
esignature/get_v2_1_accounts_by_account_id_billing_paymentsRetrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administratoraccountId (string)
from_date (string)
to_date (string)
esignature/post_v2_1_accounts_by_account_id_billing_paymentsPosts a payment to a past due invoice. This method can only be used if the paymentAllowed value for a past due invoice is true. This can be determined calling Billing::listInvoicesPastDue/docs/esign-rest-api/reference/billing/invoices/listpastdue/. The response returns information for a single payment if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. IaccountId (string)
data: {
. paymentAmount (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_billing_payments_by_payment_idRetrieves the information for a specified payment. Privileges required: account administratoraccountId (string)
paymentId (string)
esignature/get_v2_1_accounts_by_account_id_billing_planRetrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to false. Response The response returns the billing plan information, including the currency code, for the plan. The billingPlan and suaccountId (string)
include_credit_card_information (string)
include_downgrade_information (string)
include_metadata (string)
include_successor_plans (string)
include_tax_exempt_id (string)
esignature/put_v2_1_accounts_by_account_id_billing_planUpdates the billing plan information, billing address, and credit card information for the specified account.accountId (string)
preview_billing_plan (string)
data: {
. appStoreReceipt
. billingAddress
. creditCardInformation
. directDebitProcessorInformation
. downgradeReason (string)
. enablePreAuth (string)
. enableSupport (string)
. includedSeats (string)
. incrementalSeats (string)
. paymentMethod (string)
. paymentProcessor (string)
. paymentProcessorInformation
. planInformation
. processPayment (string)
. referralInformation
. renewalStatus (string)
. saleDiscountAmount (string)
. saleDiscountFixedAmount (string)
. saleDiscountPercent (string)
. saleDiscountPeriods (string)
. saleDiscountSeatPriceOverride (string)
. taxExemptId (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_billing_plan_credit_cardThis method returns information about a credit card associated with an account.accountId (string)
esignature/get_v2_1_accounts_by_account_id_billing_plan_downgradeReturns downgrade plan information for the specified account.accountId (string)
esignature/put_v2_1_accounts_by_account_id_billing_plan_downgradeQueues downgrade billing plan request for an account.accountId (string)
data: {
. downgradeEventType (string)
. planInformation
. promoCode (string)
. saleDiscount (string)
. saleDiscountPeriods (string)
. saleDiscountType (string)
} (object) required
esignature/put_v2_1_accounts_by_account_id_billing_plan_purchased_envelopesReserved: At this time, this endpoint is limited to Docusign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.accountId (string)
data: {
. amount (string)
. appName (string)
. currencyCode (string)
. platform (string)
. productId (string)
. quantity (string)
. receiptData (string)
. storeName (string)
. transactionId (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_brandsThis method returns details about all of the brands/docs/esign-rest-api/esign101/concepts/branding/ associated with an account, including the default brand profiles. Either or both of the following settings must be enabled for the account to use this method: - canSelfBrandSign - canSelfBrandSend Related topics - How to create a brand/docs/esign-rest-api/how-to/create-brand/ - How to apply a brand to an envelope/docs/esign-rest-api/how-to/apply-brand-to-envelope/accountId (string)
exclude_distributor_brand (string)
include_logos (string)
esignature/post_v2_1_accounts_by_account_id_brandsThis method creates one or more brand profile files for an account. To specify logos for the brand, use the AccountBrands: updateLogo/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/ method after you create the brand. Either or both of the following settings must be enabled for the account to use this method: - canSelfBrandSign - canSelfBrandSend Related topics - How to create a brand/docs/esign-rest-api/how-to/create-brand/accountId (string)
data: {
. brandCompany (string)
. brandId (string)
. brandLanguages (array)
. brandName (string)
. colors (array)
. defaultBrandLanguage (string)
. emailContent (array)
. errorDetails
. isOrganizationBrand (string)
. isOverridingCompanyName (boolean)
. isSendingDefault (boolean)
. isSigningDefault (boolean)
. landingPages (array)
. links (array)
. logoIds
. logos
. organizationBrandLogo (string)
. resources
} (object) required
esignature/delete_v2_1_accounts_by_account_id_brandsThis method deletes one or more brand profiles from an account, based on the brand IDs that you include in the brandsRequest. Either or both of the following settings must be enabled for the account to use this method: - canSelfBrandSign - canSelfBrandSend Related topics - How to create a brand/docs/esign-rest-api/how-to/create-brand/accountId (string)
data: {
. brands (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_brands_by_brand_idThis method returns details about an account brand/docs/esign-rest-api/esign101/concepts/branding/. Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true.accountId (string)
brandId (string)
include_external_references (string)
include_logos (string)
esignature/put_v2_1_accounts_by_account_id_brands_by_brand_idThis method updates an account brand. Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true.accountId (string)
brandId (string)
replace_brand (string)
data: {
. brandCompany (string)
. brandId (string)
. brandLanguages (array)
. brandName (string)
. colors (array)
. defaultBrandLanguage (string)
. emailContent (array)
. errorDetails
. isOrganizationBrand (string)
. isOverridingCompanyName (boolean)
. isSendingDefault (boolean)
. isSigningDefault (boolean)
. landingPages (array)
. links (array)
. logoIds
. logos
. organizationBrandLogo (string)
. resources
} (object) required
esignature/delete_v2_1_accounts_by_account_id_brands_by_brand_idThis method deletes a brand/docs/esign-rest-api/esign101/concepts/branding/ from an account. Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true.accountId (string)
brandId (string)
esignature/get_v2_1_accounts_by_account_id_brands_by_brand_id_fileThis method exports information about a brand to an XML file. Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true.accountId (string)
brandId (string)
esignature/get_v2_1_accounts_by_account_id_brands_by_brand_id_logos_by_logo_typeThis method returns a specific logo that is used in a brand. Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true.accountId (string)
brandId (string)
logoType (string)
esignature/put_v2_1_accounts_by_account_id_brands_by_brand_id_logos_by_logo_typeThis method updates a single brand logo. You pass in the new version of the resource in the Content-Disposition header. Example: Content-Disposition: form-data; name='file'; filename='logo.jpg' Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true.accountId (string)
brandId (string)
logoType (string)
data (string) required
esignature/delete_v2_1_accounts_by_account_id_brands_by_brand_id_logos_by_logo_typeThis method deletes a single logo from an account brand. Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true.accountId (string)
brandId (string)
logoType (string)
esignature/get_v2_1_accounts_by_account_id_brands_by_brand_id_resourcesThis method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true.accountId (string)
brandId (string)
esignature/get_v2_1_accounts_by_account_id_brands_by_brand_id_resources_by_resource_content_typeThis method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive embedded signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. Important: When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download yaccountId (string)
brandId (string)
resourceContentType (string)
langcode (string)
return_master (string)
esignature/put_v2_1_accounts_by_account_id_brands_by_brand_id_resources_by_resource_content_typeThis method updates a branding resource file. You pass in the new version of the resource file in the Content-Disposition header. Example: Content-Disposition: form-data; name='file'; filename='DocuSign_SigningResource_4328673.xml' Note: Branding for either signing or sending must be enabled for the account canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true. Important: Customizing resource files is an advanced branding configuration option which can significaaccountId (string)
brandId (string)
resourceContentType (string)
esignature/get_v2_1_accounts_by_account_id_bulk_send_batchReturns a summary of bulk send batches. Use the batch_ids query parameter to narrow the list of batches. You must specify exactly one of the following query parameters to get back a list of batch summaries: | Parameter | Description | | :---------------- | :------------------------------------------------------------------------------- | | from_date | A valid UTC DateTime: 2016-01-01accountId (string)
batch_ids (string)
count (string)
from_date (string)
search_text (string)
start_position (string)
status (string)
to_date (string)
user_id (string)
esignature/get_v2_1_accounts_by_account_id_bulk_send_batch_by_bulk_send_batch_idGets the general status of a specific bulk send batch such as: - number of successes - number pending - number of errors The bulkErrors property of the response object contains more information about the errors. Related topics - How to bulk send envelopes/docs/esign-rest-api/how-to/bulk-send-envelopes/accountId (string)
bulkSendBatchId (string)
esignature/put_v2_1_accounts_by_account_id_bulk_send_batch_by_bulk_send_batch_idUpdates the name of a bulk send batch.accountId (string)
bulkSendBatchId (string)
data: {
. batchName (string)
} (object) required
esignature/put_v2_1_accounts_by_account_id_bulk_send_batch_by_bulk_send_batch_id_by_bulk_actionUse this endpoint to resend, correct, or void all envelopes from a specified bulk send.accountId (string)
bulkAction (string)
bulkSendBatchId (string)
data: {
. action (string)
. notification
. voidReason (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_bulk_send_batch_by_bulk_send_batch_id_envelopesThis method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.accountId (string)
bulkSendBatchId (string)
count (string)
include (string)
order (string)
order_by (string)
search_text (string)
start_position (string)
status (string)
esignature/get_v2_1_accounts_by_account_id_bulk_send_listsThis method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.accountId (string)
esignature/post_v2_1_accounts_by_account_id_bulk_send_listsThis method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once. Related topics - How to bulk send envelopes/docs/esign-rest-api/how-to/bulk-send-envelopes/ Errors | Error code | DescriptionaccountId (string)
data: {
. bulkCopies (array)
. listId (string)
. name (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_bulk_send_lists_by_bulk_send_list_idThis method returns all of the details associated with a specific bulk send list that belongs to the current user.accountId (string)
bulkSendListId (string)
esignature/put_v2_1_accounts_by_account_id_bulk_send_lists_by_bulk_send_list_idThis method replaces the definition of an existing bulk send list.accountId (string)
bulkSendListId (string)
data: {
. bulkCopies (array)
. listId (string)
. name (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_bulk_send_lists_by_bulk_send_list_idThis method deletes a bulk send list.accountId (string)
bulkSendListId (string)
esignature/post_v2_1_accounts_by_account_id_bulk_send_lists_by_bulk_send_list_id_sendThis method initiates the bulk send process. It generates a bulk send request based on an existing bulk send listcreate_list and an envelope or template. Consider using the BulkSend::createBulkSendTestRequestcreate_test method to test your bulk send list for compatibility with the envelope or template that you want to send first. To learn about the complete bulk send flow, see the Bulk Send overviewBulkSendOverview. If the envelopes were successfully queued for asynchronous processing, the resaccountId (string)
bulkSendListId (string)
data: {
. batchName (string)
. envelopeOrTemplateId (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_bulk_send_lists_by_bulk_send_list_id_testThis method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first. A successful test result returns true for the canBeSent property. An unsuccessful test returns a JSON response that contains information about the errors that occurred. If the test is successful, you can then send thaccountId (string)
bulkSendListId (string)
data: {
. batchName (string)
. envelopeOrTemplateId (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_captive_recipients_by_recipient_partThis method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.accountId (string)
recipientPart (string)
data: {
. captiveRecipients (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_chunked_uploadsThis method initiates a new chunked upload with the first part of the content.accountId (string)
data: {
. chunkedUploadId (string)
. data (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_chunked_uploads_by_chunked_upload_idReturns the details but not the content about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.accountId (string)
chunkedUploadId (string)
include (string)
esignature/put_v2_1_accounts_by_account_id_chunked_uploads_by_chunked_upload_idThis method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts.accountId (string)
chunkedUploadId (string)
action (string)
esignature/delete_v2_1_accounts_by_account_id_chunked_uploads_by_chunked_upload_idDeletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will conaccountId (string)
chunkedUploadId (string)
esignature/put_v2_1_accounts_by_account_id_chunked_uploads_by_chunked_upload_id_by_chunked_upload_part_seqAdds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, Docusign recommends that you upload the parts in their sequential order 1,2, 3, 4, etc.. The Create method adds the first part and assigns it the sequence value 0. As a result, Docusign recommends that you start with a sequence value of 1 when you use this method, and continue uploading partsaccountId (string)
chunkedUploadId (string)
chunkedUploadPartSeq (string)
data: {
. chunkedUploadId (string)
. data (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_connectRetrieves all the Docusign Custom Connect definitions for the specified account. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
esignature/put_v2_1_accounts_by_account_id_connectUpdates the specified Docusign Connect configuration in your account. To enable the configuration, set the allowEnvelopePublish property to true. After any updates, test your configuration to make sure it works as expected. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
data: {
. allowEnvelopePublish (string)
. allowSalesforcePublish (string)
. allUsers (string)
. allUsersExcept (string)
. configurationType (string)
. connectId (string)
. deliveryMode (string)
. disabledBy (string)
. enableLog (string)
. enableOAuthPerConfiguration (string)
. envelopeEvents (array)
. eventData
. events (array)
. externalFolderId (string)
. externalFolderLabel (string)
. groupIds (array)
. includeCertificateOfCompletion (string)
. includeCertSoapHeader (string)
. includeDocumentFields (string)
. includeDocuments (string)
. includeEnvelopeVoidReason (string)
. includeHMAC (string)
. includeOAuth (string)
. includeSenderAccountasCustomField (string)
. includeTimeZoneInformation (string)
. integratorManaged (string)
. name (string)
. oAuthConfiguration
. password (string)
. pausePublish (string)
. recipientEvents (array)
. requireMutualTls (string)
. requiresAcknowledgement (string)
. salesforceApiVersion (string)
. salesforceAuthcode (string)
. salesforceCallBackUrl (string)
. salesforceDocumentsAsContentFiles (string)
. senderOverride (string)
. senderSelectableItems (array)
. sfObjects (array)
. signMessageWithX509Certificate (string)
. soapNamespace (string)
. urlToPublishTo (string)
. userIds (array)
. userName (string)
. useSoapInterface (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_connectCreates a custom Connect configuration for the specified account. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessage Connect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create: Account-level Connect configurations to listen for events related to any envelopes sent by one or more account users Recipient Connect configurationaccountId (string)
data: {
. allowEnvelopePublish (string)
. allowSalesforcePublish (string)
. allUsers (string)
. allUsersExcept (string)
. configurationType (string)
. connectId (string)
. deliveryMode (string)
. disabledBy (string)
. enableLog (string)
. enableOAuthPerConfiguration (string)
. envelopeEvents (array)
. eventData
. events (array)
. externalFolderId (string)
. externalFolderLabel (string)
. groupIds (array)
. includeCertificateOfCompletion (string)
. includeCertSoapHeader (string)
. includeDocumentFields (string)
. includeDocuments (string)
. includeEnvelopeVoidReason (string)
. includeHMAC (string)
. includeOAuth (string)
. includeSenderAccountasCustomField (string)
. includeTimeZoneInformation (string)
. integratorManaged (string)
. name (string)
. oAuthConfiguration
. password (string)
. pausePublish (string)
. recipientEvents (array)
. requireMutualTls (string)
. requiresAcknowledgement (string)
. salesforceApiVersion (string)
. salesforceAuthcode (string)
. salesforceCallBackUrl (string)
. salesforceDocumentsAsContentFiles (string)
. senderOverride (string)
. senderSelectableItems (array)
. sfObjects (array)
. signMessageWithX509Certificate (string)
. soapNamespace (string)
. urlToPublishTo (string)
. userIds (array)
. userName (string)
. useSoapInterface (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_connect_by_connect_idRetrieves the information for the specified Docusign Connect configuration. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
connectId (string)
esignature/delete_v2_1_accounts_by_account_id_connect_by_connect_idDeletes the specified Docusign Connect configuration. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
connectId (string)
esignature/get_v2_1_accounts_by_account_id_connect_by_connect_id_all_usersReturns all users from the configured Connect service. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
connectId (string)
count (string)
domain_users_only (string)
email_substring (string)
start_position (string)
status (string)
user_name_substring (string)
esignature/get_v2_1_accounts_by_account_id_connect_by_connect_id_usersReturns users from the configured Connect service. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
connectId (string)
count (string)
email_substring (string)
list_included_users (string)
start_position (string)
status (string)
user_name_substring (string)
esignature/put_v2_1_accounts_by_account_id_connect_envelopes_by_envelope_id_retry_queueRepublishes Connect information for the specified envelope. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
envelopeId (string)
esignature/post_v2_1_accounts_by_account_id_connect_envelopes_publish_historicalThis endpoint submits a batch of existing envelopes to a webhook of your choice. Set the webhook address with the urlToPublishTo request body parameter. This endpoint does not call an existing Connect configuration or create a new Connect listener to monitor new activity. It simply uses an ad hoc configuration to submit existing envelopes. You must include all the configuration data in the request body. The envelope data will always be transmitted in JSON format. XML, Salesforce, and eOriginalaccountId (string)
data: {
. config
. envelopes (array)
} (object) required
esignature/put_v2_1_accounts_by_account_id_connect_envelopes_retry_queueRepublishes Connect information for the specified set of envelopes. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessage The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to Connect::listEventLogs/docs/esign-rest-api/reference/connect/connecteveaccountId (string)
data: {
. envelopeIds (array)
. synchronous (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_connect_failuresRetrieves the Connect failure log information. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessage Use this method to determine which envelopes failed to post. You can then use ConnectEvents: retryForEnvelopesretry to create a republish request. retry: /docs/esign-rest-api/reference/connect/connectevents/retryforenvelopes/accountId (string)
from_date (string)
to_date (string)
esignature/delete_v2_1_accounts_by_account_id_connect_failures_by_failure_idDeletes a Connect failure log entry. To delete all the Connect failure log entries, specify all for the failureId path parameter. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
failureId (string)
esignature/get_v2_1_accounts_by_account_id_connect_logsRetrieves a list of the 100 most recent Connect log entries for your account. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessage The enableLog setting in the Connect configuration must be set to true to enable logging. Log entries are deleted after 15 days.accountId (string)
from_date (string)
to_date (string)
esignature/delete_v2_1_accounts_by_account_id_connect_logsDeletes a list of Connect log entries for your account. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
esignature/get_v2_1_accounts_by_account_id_connect_logs_by_log_idRetrieves the specified Connect log entry for your account. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessage The enableLog setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.accountId (string)
logId (string)
additional_info (string)
esignature/delete_v2_1_accounts_by_account_id_connect_logs_by_log_idDeletes a specified entry from the Connect Log. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessageaccountId (string)
logId (string)
esignature/get_v2_1_accounts_by_account_id_connect_oauthGets the Connect OAuth configuration for the specified account. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessage Related topics: - OAuth for Docusign Connect/platform/webhooks/connect/validation-and-security/oauth-connect/accountId (string)
esignature/put_v2_1_accounts_by_account_id_connect_oauthUpdates the existing Connect OAuth configuration for the account.accountId (string)
data: {
. authorizationServerUrl (string)
. clientId (string)
. clientSecret (string)
. customParameters (object)
. scope (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_connect_oauthSets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server. When you call this endpoint, Docusign requests an access token from your authorization server. Docusign will use that token in the Authorization HTTP header of your account's Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server. ds-inlinemessageaccountId (string)
data: {
. authorizationServerUrl (string)
. clientId (string)
. clientSecret (string)
. customParameters (object)
. scope (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_connect_oauthDeletes the Connect OAuth configuration for the specified account. ds-inlinemessage To use this method, you must be an account administrator and Connect must be enabled on your account. /ds-inlinemessage Related topics: - OAuth for Docusign Connect/platform/webhooks/connect/validation-and-security/oauth-connect/accountId (string)
esignature/get_v2_1_accounts_by_account_id_consumer_disclosureRetrieves the default, HTML-formatted Electronic Record and Signature Disclosure ERSD associated with the account. This is the default ERSD disclosure that Docusign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties. To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.accountId (string)
langCode (string)
esignature/get_v2_1_accounts_by_account_id_consumer_disclosure_by_lang_codeRetrieves the HTML-formatted Electronic Record and Signature Disclosure ERSD associated with the account. To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter. Note: The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the langCode parameter to specify the signer language version that you want to retrieve.accountId (string)
langCode (string)
esignature/put_v2_1_accounts_by_account_id_consumer_disclosure_by_lang_codeAccount administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional langCode query parameter. Note: Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipienaccountId (string)
langCode (string)
include_metadata (string)
data: {
. accountEsignId (string)
. allowCDWithdraw (string)
. allowCDWithdrawMetadata
. changeEmail (string)
. changeEmailOther (string)
. companyName (string)
. companyPhone (string)
. copyCostPerPage (string)
. copyFeeCollectionMethod (string)
. copyRequestEmail (string)
. custom (string)
. enableEsign (string)
. esignAgreement (string)
. esignText (string)
. languageCode (string)
. mustAgreeToEsign (string)
. pdfId (string)
. useBrand (string)
. useConsumerDisclosureWithinAccount (string)
. useConsumerDisclosureWithinAccountMetadata
. withdrawAddressLine1 (string)
. withdrawAddressLine2 (string)
. withdrawByEmail (string)
. withdrawByMail (string)
. withdrawByPhone (string)
. withdrawCity (string)
. withdrawConsequences (string)
. withdrawEmail (string)
. withdrawOther (string)
. withdrawPhone (string)
. withdrawPostalCode (string)
. withdrawState (string)
} (object) required
esignature/put_v2_1_accounts_by_account_id_contactsThis method updates one or more contacts associated with an account.accountId (string)
data: {
. contactList (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_contactsThis method adds multiple contacts into a contacts list.accountId (string)
data: {
. contactList (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_contactsThis method deletes multiple contacts associated with an account.accountId (string)
data: {
. contactList (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_contacts_by_contact_idThis method returns one or more contacts associated with a Docusign account. You can also retrieve contacts from connected cloud storageCloudStorage providers by using the cloud_provider query parameter. By default, contacts are retrieved from the Docusign account's default address book. To return a specific contact, use the contactId query parameter. To return all contacts associated with an account, omit this parameter. CloudStorage: /docs/esign-rest-api/reference/cloudstorage/accountId (string)
contactId (string)
cloud_provider (string)
esignature/delete_v2_1_accounts_by_account_id_contacts_by_contact_idThis method deletes a contact associated with an account.accountId (string)
contactId (string)
esignature/get_v2_1_accounts_by_account_id_custom_fieldsThis method returns a list of the envelope and document custom fields associated with an account.accountId (string)
esignature/post_v2_1_accounts_by_account_id_custom_fieldsThis method creates a custom field and makes it available for all new envelopes associated with an account.accountId (string)
apply_to_templates (string)
data: {
. customFieldType (string)
. errorDetails
. fieldId (string)
. listItems (array)
. name (string)
. required (string)
. show (string)
. value (string)
} (object) required
esignature/put_v2_1_accounts_by_account_id_custom_fields_by_custom_field_idThis method updates an existing account custom field.accountId (string)
customFieldId (string)
apply_to_templates (string)
data: {
. customFieldType (string)
. errorDetails
. fieldId (string)
. listItems (array)
. name (string)
. required (string)
. show (string)
. value (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_custom_fields_by_custom_field_idThis method deletes an existing account custom field.accountId (string)
customFieldId (string)
apply_to_templates (string)
esignature/get_v2_1_accounts_by_account_id_envelopesThis method lets you search for envelopes/docs/esign-rest-api/esign101/concepts/envelopes/search/ in your accounts. A large set of filters let you narrow the scope of your search by date, by envelope ID, or by status codes. Your request must include one or more of the following parameters: from_date envelope_ids transaction_ids Restrictions The number of envelopes returned is limited to 1,000 per call. To retrieve the next or previous set of envelopes, use the nextUri and previousUri paccountId (string)
ac_status (string)
block (string)
cdse_mode (string)
continuation_token (string)
count (string)
custom_field (string)
email (string)
envelope_ids (string)
exclude (string)
folder_ids (string)
folder_types (string)
from_date (string)
from_to_status (string)
include (string)
include_purge_information (string)
intersecting_folder_ids (string)
last_queried_date (string)
order (string)
order_by (string)
powerformids (string)
query_budget (string)
requester_date_format (string)
search_mode (string)
search_text (string)
start_position (string)
status (string)
to_date (string)
transaction_ids (string)
user_filter (string)
user_id (string)
user_name (string)
esignature/post_v2_1_accounts_by_account_id_envelopesCreates and sends an envelope or creates a draft envelope. Envelopes are fundamental resources in the Docusign platform. With this method you can: Create and send an envelope with documents, recipients, and tabs. Create and send an envelope from a template/docs/esign-rest-api/esign101/concepts/templates/. Create and send an envelope from a combination of documents and templates/docs/esign-rest-api/esign101/concepts/templates/composite/. Create a draft envelope. When you use this metaccountId (string)
cdse_mode (string)
change_routing_order (string)
completed_documents_only (string)
merge_roles_on_draft (string)
data: {
. accessControlListBase64 (string)
. accessibility (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowRecipientRecursion (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachments (array)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. compositeTemplates (array)
. copyRecipientData (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documents (array)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. eventNotification
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModifiedDateTime (string)
. location (string)
. lockInformation
. messageLock (string)
. notification
. notificationUri (string)
. password (string)
. powerForm
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. recipientViewRequest
. sender
. sentDateTime (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templateId (string)
. templateRoles (array)
. templatesUri (string)
. transactionId (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_idRetrieves the overall status for the specified envelope. To get the status of a list of envelopes, use Envelope: listStatusChanges /docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/. Related topics - How to get envelope information/docs/esign-rest-api/how-to/get-envelope-information/accountId (string)
envelopeId (string)
advanced_update (string)
include (string)
include_anchor_tab_locations (string)
user_id (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_idThis method enables you to make changes to an envelope. You can use it to: Send a draft envelope sending-a-draft-envelope Void an in-process envelope voiding-an-in-process-envelope Modify a draft envelope modifying-envelope-email-information Purge documents and envelope metadata from the Docusign platform purging-documents-from-docusign Although the request body for this method is a complete envelope definition, you only need to provide the properties that you're updating. Sending a draccountId (string)
envelopeId (string)
advanced_update (string)
recycle_on_void (string)
resend_envelope (string)
data: {
. accessControlListBase64 (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. copyRecipientData (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModifiedDateTime (string)
. location (string)
. lockInformation
. messageLock (string)
. notification
. notificationUri (string)
. powerForm
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. sender
. sentDateTime (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templatesUri (string)
. transactionId (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_attachmentsReturns a list of envelope attachments associated with a specified envelope. !-- std notice DEVDOCS-114911 -- ds-inlinemessage kind='information' markdown='1' It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To get a list of user-visible attachments, use EnvelopeDocuments: get/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/. To learn about the different types of attachments, see Attachments/docs/esiaccountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_attachmentsAdds one or more envelope attachments to a draft or in-process envelope. Each envelope can have a maximum of 12 attachments. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the Docusign web application for them. For a list of supported file formats, see Supported File Formatshttps://support.docusign.com/s/document-item?bundleId=gbo1643332197980 anaccountId (string)
envelopeId (string)
data: {
. attachments (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_attachmentsDeletes one or more envelope attachments from a draft envelope. !-- std notice DEVDOCS-114911 -- ds-inlinemessage kind='information' markdown='1' It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To learn about the different types of attachments, see Attachments/docs/esign-rest-api/esign101/concepts/documents/attachments/ in the concept guide. /ds-inlinemessage !-- end notice DEVDOCS-114911 --accountId (string)
envelopeId (string)
data: {
. attachments (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_attachments_by_attachment_idRetrieves an envelope attachment from an envelope. !-- std notice DEVDOCS-114911 -- ds-inlinemessage kind='information' markdown='1' It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To learn about the different types of attachments, see Attachments/docs/esign-rest-api/esign101/concepts/documents/attachments/ in the concept guide. /ds-inlinemessage !-- end notice DEVDOCS-114911 --accountId (string)
attachmentId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_attachments_by_attachment_idUpdates an envelope attachment to a draft or in-process envelope. !-- std notice DEVDOCS-114911 -- ds-inlinemessage kind='information' markdown='1' It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To learn about the different types of attachments, see Attachments/docs/esign-rest-api/esign101/concepts/documents/attachments/ in the concept guide. /ds-inlinemessage !-- end notice DEVDOCS-114911 --accountId (string)
attachmentId (string)
envelopeId (string)
data: {
. accessControl (string)
. attachmentId (string)
. attachmentType (string)
. data (string)
. label (string)
. name (string)
. remoteUrl (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_audit_eventsGets the envelope audit events for the specified envelope.accountId (string)
envelopeId (string)
locale (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_comments_transcriptRetrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account in the accountSettingsInformation object, set the enableSigningExtensionComments property to true.accountId (string)
envelopeId (string)
encoding (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_custom_fieldsRetrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the Docusign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custoaccountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_custom_fieldsUpdates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.accountId (string)
envelopeId (string)
data: {
. listCustomFields (array)
. textCustomFields (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_custom_fieldsUpdates the envelope custom fields for draft and in-process envelopes. Related topics - How to bulk send envelopes/docs/esign-rest-api/how-to/bulk-send-envelopes/accountId (string)
envelopeId (string)
data: {
. listCustomFields (array)
. textCustomFields (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_custom_fieldsDeletes envelope custom fields for draft and in-process envelopes.accountId (string)
envelopeId (string)
data: {
. listCustomFields (array)
. textCustomFields (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_doc_gen_form_fieldsGiven an envelopeId, this method returns the sender fields found in that envelope's documents. After you retrieve the sender fields, use the DocumentGeneration::updateEnvelopeDocGenFormFields/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/ method to populate the fields. If the specified envelope does not contain a document with sender fields, the method will return success 200 and an empty object in the response. Next steps - Learn about documenaccountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_doc_gen_form_fieldsThis method dynamically generates an envelope's documents by populating its sender fields. The envelope must be in a draft state. Use the DocumentGeneration::getEnvelopeDocGenFormFields/docs/esign-rest-api/reference/envelopes/documentgeneration/getenvelopedocgenformfields/ response to retrieve the list of sender fields for your envelope. Use that list to build the request for this method. For each field, specify the field name and the value to populate. For example, your request body might looaccountId (string)
envelopeId (string)
update_docgen_formfields_only (string)
data: {
. docGenFormFields (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documentsRetrieves a list of documents associated with the specified envelope. Related topics - How to list envelope documents/docs/esign-rest-api/how-to/list-envelope-documents/accountId (string)
envelopeId (string)
documents_by_userid (string)
include_agreement_type (string)
include_docgen_formfields (string)
include_metadata (string)
include_tabs (string)
recipient_id (string)
shared_user_id (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documentsAdds one or more documents to an existing envelope. The tabs of the original document will be applied to the new document. Note: When adding or modifying documents for an in-process envelope, Docusign recommends locking the envelope/docs/esign-rest-api/reference/envelopes/envelopelocks/create/ prior to making any changes. If the file name of a document contains Unicode characters, you need to include a Content-Disposition header. Example: Header: Content-Disposition Value: file; filename=accountId (string)
envelopeId (string)
data: {
. accessControlListBase64 (string)
. accessibility (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowRecipientRecursion (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachments (array)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. compositeTemplates (array)
. copyRecipientData (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documents (array)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. eventNotification
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModifiedDateTime (string)
. location (string)
. lockInformation
. messageLock (string)
. notification
. notificationUri (string)
. password (string)
. powerForm
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. recipientViewRequest
. sender
. sentDateTime (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templateId (string)
. templateRoles (array)
. templatesUri (string)
. transactionId (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documentsDeletes one or more documents from an existing envelope that has not yet been completed. To delete a document, use only the relevant parts of the envelopeDefinition envelopeDefinition. For example, this request body specifies that you want to delete the document whose documentId is '1'. text 'documents': 'documentId': '1' The envelope status must be one of: - created - sent - deliveredaccountId (string)
envelopeId (string)
data: {
. accessControlListBase64 (string)
. accessibility (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowRecipientRecursion (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachments (array)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. compositeTemplates (array)
. copyRecipientData (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documents (array)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. eventNotification
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModifiedDateTime (string)
. location (string)
. lockInformation
. messageLock (string)
. notification
. notificationUri (string)
. password (string)
. powerForm
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. recipientViewRequest
. sender
. sentDateTime (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templateId (string)
. templateRoles (array)
. templatesUri (string)
. transactionId (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_idRetrieves a single document or all documents from an envelope. To retrieve a single document, provide the ID of the document in the documentId path parameter. Alternatively, by setting the documentId parameter to special keyword values, you can retrieve all the documents as a combined PDF, portfolio PDF, or ZIP archive or just the certificate of completion. See the documentId description for how to retrieve each format. The response body of this method is a file. If you request multiple documaccountId (string)
documentId (string)
envelopeId (string)
certificate (string)
documents_by_userid (string)
encoding (string)
encrypt (string)
language (string)
recipient_id (string)
shared_user_id (string)
show_changes (string)
watermark (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_idAdds or replaces a document in an existing draft or in-process envelope. An in-process envelope is one that has been sent but not yet completed or voided. Note: When adding or modifying documents for an in-process envelope, Docusign recommends locking the envelope/docs/esign-rest-api/reference/envelopes/envelopelocks/create/ prior to making any changes. To add a new document, set the documentId path parameter to a new document ID. To replace a document, set the documentId path parameter to taccountId (string)
documentId (string)
envelopeId (string)
data (string) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_fieldsRetrieves the custom document field information from an existing envelope document.accountId (string)
documentId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_fieldsUpdates existing custom document fields in an existing envelope document.accountId (string)
documentId (string)
envelopeId (string)
data: {
. documentFields (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_fieldsCreates custom document fields in an existing envelope document.accountId (string)
documentId (string)
envelopeId (string)
data: {
. documentFields (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_fieldsDeletes custom document fields from an existing envelope document.accountId (string)
documentId (string)
envelopeId (string)
data: {
. documentFields (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_html_definitionsRetrieves the HTML definition used to generate a dynamically sized responsive document. If the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body. Note: The documentId query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body. Related topics - Responsive signing/docs/esign-rest-api/esign101/concepts/responsive/accountId (string)
documentId (string)
envelopeId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_pagesReturns images of the pages in a document for display based on the parameters that you specify.accountId (string)
documentId (string)
envelopeId (string)
count (string)
dpi (string)
max_height (string)
max_width (string)
nocache (string)
show_changes (string)
start_position (string)
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_pages_by_page_numberDeletes a page from a document in an envelope based on the page number.accountId (string)
documentId (string)
envelopeId (string)
pageNumber (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_pages_by_page_number_page_imageReturns an image of a page in a document for display.accountId (string)
documentId (string)
envelopeId (string)
pageNumber (string)
dpi (string)
max_height (string)
max_width (string)
show_changes (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_pages_by_page_number_page_imageRotates page image from an envelope for display. The page image can be rotated to the left or right.accountId (string)
documentId (string)
envelopeId (string)
pageNumber (string)
data: {
. password (string)
. rotate (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_pages_by_page_number_tabsReturns the tabs from the page specified by pageNumber of the document specified by documentId in the envelope specified by envelopeId.accountId (string)
documentId (string)
envelopeId (string)
pageNumber (string)
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_responsive_html_previewCreates a preview of the responsive/docs/esign-rest-api/esign101/concepts/responsive/ HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.accountId (string)
documentId (string)
envelopeId (string)
data: {
. displayAnchorPrefix (string)
. displayAnchors (array)
. displayOrder (string)
. displayPageNumber (string)
. documentGuid (string)
. documentId (string)
. headerLabel (string)
. maxScreenWidth (string)
. removeEmptyTags (string)
. showMobileOptimizedToggle (string)
. source (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_tabsReturns the tabs on the document specified by documentId in the envelope specified by envelopeId.accountId (string)
documentId (string)
envelopeId (string)
include_metadata (string)
page_numbers (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_tabsUpdates tabs in the document specified by documentId in the envelope specified by envelopeId. ds-inlinemessage kind='information' markdown='1' This method operates only on a href='/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/ schema__enveloperecipienttabs_smartsectiontabs'codesmartSection/code/a and a href='/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/ schema__enveloperecipienttabs_polylineoverlaytabs'codepolyLineOverlay/code/a tabs. /ds-inlinemaccountId (string)
documentId (string)
envelopeId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_tabsAdds tabs to the document specified by documentId in the envelope specified by envelopeId. ds-inlinemessage kind='information' markdown='1' This method operates only on a href='/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/ schema__enveloperecipienttabs_smartsectiontabs'codesmartSection/code/a and a href='/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/ schema__enveloperecipienttabs_polylineoverlaytabs'codepolyLineOverlay/code/a tabs. /ds-inlinemessaccountId (string)
documentId (string)
envelopeId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_tabsDeletes tabs from the document specified by documentId in the envelope specified by envelopeId.accountId (string)
documentId (string)
envelopeId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_templatesRetrieves the templates associated with a document in the specified envelope.accountId (string)
documentId (string)
envelopeId (string)
include (string)
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_templatesAdds templates to a document in the specified envelope.accountId (string)
documentId (string)
envelopeId (string)
preserve_template_recipient (string)
data: {
. documentTemplates (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_documents_by_document_id_templates_by_template_idDeletes the specified template from a document in an existing envelope.accountId (string)
documentId (string)
envelopeId (string)
templateId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_email_settingsRetrieves the email override settings for the specified envelope.accountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_email_settingsUpdates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.accountId (string)
envelopeId (string)
data: {
. bccEmailAddresses (array)
. replyEmailAddressOverride (string)
. replyEmailNameOverride (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_email_settingsAdds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery reaccountId (string)
envelopeId (string)
data: {
. bccEmailAddresses (array)
. replyEmailAddressOverride (string)
. replyEmailNameOverride (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_email_settingsDeletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.accountId (string)
envelopeId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_form_dataThis method downloads the envelope and tab data also called form data from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting 'Allow sender to download form data' must be enabled for the account. Related topics - How to get envelope tab values/docs/esign-rest-aaccountId (string)
envelopeId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_html_definitionsGets the Original HTML Definition used to generate the Responsive HTML for the envelope.accountId (string)
envelopeId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_lockRetrieves general information about an envelope lock. The user requesting the information must be the same user who locked the envelope. You can use this method to recover the lock information, including the lockToken, for a locked envelope. The X-DocuSign-Edit header is included in the response. See EnvelopeLocks: create/docs/esign-rest-api/reference/envelopes/envelopelocks/create/ for a description of the X-DocuSign-Edit header. Related topics - Common API Tasks: Locking and unlockingaccountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_lockUpdates the lock information for a locked envelope. You must include the X-DocuSign-Edit header as described in EnvelopeLocks: create/docs/esign-rest-api/reference/envelopes/envelopelocks/create/. Use this method to change the duration of the lock lockDurationInSeconds or the lockedByApp string. The request body is a full lockRequest object, but you only need to specify the properties that you are updating. For example: 'lockDurationInSeconds': '3600', 'lockedByApp': 'My Application'accountId (string)
envelopeId (string)
data: {
. lockDurationInSeconds (string)
. lockedByApp (string)
. lockType (string)
. templatePassword (string)
. useScratchPad (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_lockThis method locks the specified envelope and sets the time until the lock expires to prevent other users or recipients from changing the envelope. The response to this request includes a lockToken parameter that you must use in the X-DocuSign-Edit header for every PUT method typically a method that updates an envelope while the envelope is locked. If you do not provide the lockToken when accessing a locked envelope, you will get the following error: 'errorCode': 'EDIT_LOCK_NOT_LOCK_OWNEaccountId (string)
envelopeId (string)
data: {
. lockDurationInSeconds (string)
. lockedByApp (string)
. lockType (string)
. templatePassword (string)
. useScratchPad (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_lockDeletes the lock from the specified envelope. The user deleting the lock must be the same user who locked the envelope. You must include the X-DocuSign-Edit header as described in EnvelopeLocks: create/docs/esign-rest-api/reference/envelopes/envelopelocks/create/. This method takes an optional query parameter that lets you specify whether changes made while the envelope was locked are kept or discarded. | Query Parameter | DescriptionaccountId (string)
envelopeId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_notificationRetrieves the envelope notification, reminders and expirations, information for an existing envelope.accountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_notificationThis method sets the notifications reminders and expirations for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.accountId (string)
envelopeId (string)
data: {
. expirations
. reminders
. useAccountDefaults (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipientsRetrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values. The currentRoutingOrder property of the response contains the routingOrder value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. Related topics - How to list envelope recipients/docs/esign-rest-api/how-to/get-envelope-recipients/accountId (string)
envelopeId (string)
include_anchor_tab_locations (string)
include_extended (string)
include_metadata (string)
include_tabs (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipientsUpdates the recipients of a draft envelope or corrects recipient information for an in-process envelope. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope similar to the EnvelopeRecipients: CreateEnvelopeRecipients-create method. You can also use this method to resend an envelope to a recipient by using the resend_envelope option. Updating Sent Envelopes After an envelope has been sent, you can edit only the followaccountId (string)
envelopeId (string)
combine_same_order_recipients (string)
offline_signing (string)
resend_envelope (string)
data: {
. agents (array)
. carbonCopies (array)
. certifiedDeliveries (array)
. currentRoutingOrder (string)
. editors (array)
. errorDetails
. inPersonSigners (array)
. intermediaries (array)
. notaries (array)
. notaryWitnesses (array)
. participants (array)
. recipientCount (string)
. seals (array)
. signers (array)
. witnesses (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipientsAdds one or more recipients to an envelope. For an in-process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional resend_envelope query string is set to true. Note: This method works on recipients only. To add recipient tabs, use methods from the EnvelopeRecipientTabaccountId (string)
envelopeId (string)
resend_envelope (string)
data: {
. agents (array)
. carbonCopies (array)
. certifiedDeliveries (array)
. currentRoutingOrder (string)
. editors (array)
. errorDetails
. inPersonSigners (array)
. intermediaries (array)
. notaries (array)
. notaryWitnesses (array)
. participants (array)
. recipientCount (string)
. seals (array)
. signers (array)
. witnesses (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipientsDeletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the recipientId as the key for deleting recipients. If the envelope is In Process, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.accountId (string)
envelopeId (string)
data: {
. agents (array)
. carbonCopies (array)
. certifiedDeliveries (array)
. currentRoutingOrder (string)
. editors (array)
. errorDetails
. inPersonSigners (array)
. intermediaries (array)
. notaries (array)
. notaryWitnesses (array)
. participants (array)
. recipientCount (string)
. seals (array)
. signers (array)
. witnesses (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_idDeletes a recipient from a draft or sent envelope. If the envelope is 'In Process' has been sent and is not completed or voided, recipients that have completed their actions cannot be deleted.accountId (string)
envelopeId (string)
recipientId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_consumer_disclosureRetrieves the default, HTML-formatted Electronic Record and Signature Disclosure ERSD for the envelope that you specify. This is the default ERSD disclosure that Docusign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties. To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.accountId (string)
envelopeId (string)
recipientId (string)
langCode (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_consumer_disclosure_by_lang_codeRetrieves the HTML-formatted Electronic Record and Signature Disclosure ERSD for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient's language settings. To set the language of the disclosure that you want to retrieve, specify the langCode as either a path or query parameter.accountId (string)
envelopeId (string)
langCode (string)
recipientId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_document_visibilityThis method returns information about document visibility for a recipient.accountId (string)
envelopeId (string)
recipientId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_document_visibilityThis method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery Needs to Sign, Editor, and Agent recipients can always see all documents.accountId (string)
envelopeId (string)
recipientId (string)
data: {
. documentVisibility (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_identity_proof_tokenCreates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API/docs/idevidence-api/. Related topics - How to retrieve ID Evidence events/docs/idevidence-api/how-to/retrieve-idevidence-events/ - How to retrieve ID Evidence media/docs/idevidence-api/how-to/retrieve-idevidence-media/accountId (string)
envelopeId (string)
recipientId (string)
token_scopes (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_initials_imageRetrieves the initials image for the specified recipient.accountId (string)
envelopeId (string)
recipientId (string)
include_chrome (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_initials_imageUpdates the initials image for a signer that does not have a Docusign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the CanSendEnvelope property set to true and the ExpressSendOnly property in SendingUser structure must be set to faaccountId (string)
envelopeId (string)
recipientId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_signatureRetrieves signature information for a signer or sign-in-person recipient.accountId (string)
envelopeId (string)
recipientId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_signature_imageRetrieves the specified recipient signature image.accountId (string)
envelopeId (string)
recipientId (string)
include_chrome (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_signature_imageUpdates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the CanSendEnvelope property set to true and the ExpressSendOnly property in SendingUser structure must be set to false.accountId (string)
envelopeId (string)
recipientId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_tabsRetrieves information about the tabs associated with a recipient. You can make a single API call to get all the tab values and information from a given, completed envelope in addition to draft ones. Tab values can be retrieved by using the EnvelopeRecipients:list method/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/ with query parameter include_tabs set to true.accountId (string)
envelopeId (string)
recipientId (string)
include_anchor_tab_locations (string)
include_metadata (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_tabsUpdates one or more tabs for a recipient in a draft envelope. A draft envelope is one that is not yet complete. Note: It is an error to update a tab that has the templateLocked property set to true. This property corresponds to the Restrict changes option in the web app.accountId (string)
envelopeId (string)
recipientId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_tabsAdds one or more tabs for a recipient.accountId (string)
envelopeId (string)
recipientId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_tabsDeletes one or more tabs associated with a recipient in a draft envelope.accountId (string)
envelopeId (string)
recipientId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_by_recipient_id_views_identity_manual_reviewThis method returns the URL of the page that allows a sender to manually reviewhttps://support.docusign.com/s/document-item?bundleId=ced1643229641057 and topicId=lyp1578456530647.html the ID of a recipient.accountId (string)
envelopeId (string)
recipientId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_recipients_document_visibilityThis method updates document visibility for one or more recipients based on the recipientId and visible values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery Needs to Sign, Editor, and Agent recipients can always see all documents.accountId (string)
envelopeId (string)
data: {
. documentVisibility (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_responsive_html_previewCreates a preview of the responsive/docs/esign-rest-api/esign101/concepts/responsive/, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.accountId (string)
envelopeId (string)
data: {
. displayAnchorPrefix (string)
. displayAnchors (array)
. displayOrder (string)
. displayPageNumber (string)
. documentGuid (string)
. documentId (string)
. headerLabel (string)
. maxScreenWidth (string)
. removeEmptyTags (string)
. showMobileOptimizedToggle (string)
. source (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_sharesNo description availableaccountId (string)
envelopeId (string)
data: {
. shares (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_tabs_blobThis endpoint has been deprecated.accountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_tabs_blobThis endpoint has been deprecated.accountId (string)
envelopeId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_templatesThis returns a list of the server-side templates, their name and ID, used in an envelope.accountId (string)
envelopeId (string)
include (string)
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_templatesAdds templates to the specified envelope.accountId (string)
envelopeId (string)
preserve_template_recipient (string)
data: {
. documentTemplates (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_views_correctReturns a URL that enables you to embed the envelope sender view of the Docusign UI. You can customize the appearance of the view via the settings request attribute. You can embed the view in an iframe. API request update The request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version; it solves a security issue with the old version. The deprecation schedule has been announced in the DocusignaccountId (string)
envelopeId (string)
data: {
. returnUrl (string)
. settings
. viewAccess (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_views_correctThis API method is obsolete. Your application should not call it. It acts as a null operation.accountId (string)
envelopeId (string)
data: {
. beginOnTagger (string)
. returnUrl (string)
. suppressNavigation (string)
. viewUrl (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_views_editThis API method has been replaced by the EnvelopeViews:createSender/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/ API method. The two API methods work exactly the same, Migration required To solve an application security issue, you must migrate to the new API request format. See the EnvelopeViews:createSender/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/ API method for more information. Backwards compatibility will be provided for a limited time.accountId (string)
envelopeId (string)
data: {
. returnUrl (string)
. settings
. viewAccess (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_views_recipientReturns a URL that enables you to embed the recipient view/docs/esign-rest-api/esign101/concepts/embedding/ of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony. This method is only used with envelopes in the sent status. ds-inlinemessage kind='information' markdown='1' Due to screen space issues, do not use an code and lt;iframe and gt;/code for embedded operations on mobile devices. For iOS devices, Docusign recommends using aaccountId (string)
envelopeId (string)
data: {
. assertionId (string)
. authenticationInstant (string)
. authenticationMethod (string)
. clientURLs
. clientUserId (string)
. displayFormat (string)
. email (string)
. frameAncestors (array)
. messageOrigins (array)
. pingFrequency (string)
. pingUrl (string)
. recipientId (string)
. returnUrl (string)
. securityDomain (string)
. userId (string)
. userName (string)
. xFrameOptions (string)
. xFrameOptionsAllowFromUrl (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_views_recipient_previewReturns a URL to preview the recipients' view of a draft envelope or template. You can embed this view in your application to enable the sender to preview the recipients' experience. You must specify a returnUrl value in the request body. For more information, see Preview and Sendhttps://support.docusign.com/s/document-item?bundleId=ulp1643236876813 and topicId=oeg1578456408976.html.accountId (string)
envelopeId (string)
data: {
. assertionId (string)
. authenticationInstant (string)
. authenticationMethod (string)
. clientURLs
. pingFrequency (string)
. pingUrl (string)
. recipientId (string)
. returnUrl (string)
. securityDomain (string)
. xFrameOptions (string)
. xFrameOptionsAllowFromUrl (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_views_senderReturns a URL that enables you to embed the envelope sender view of the Docusign UI. You can customize the appearance of the view via the settings request attribute. You can embed the view in an iframe. API request update The request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version; it solves a security issue with the old version. The deprecation schedule has been announced in the DocusignaccountId (string)
envelopeId (string)
data: {
. returnUrl (string)
. settings
. viewAccess (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_views_sharedReturns a URL that enables you to embed the Docusign UI recipient view of a shared envelopehttps://support.docusign.com/s/document-item?bundleId=pik1583277475390 and topicId=uzg1583277438725.html in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an iframe for embedded operations on mobile devices. For iOS devices, Docusign recommends using a WebView. Related topics - EmbeaccountId (string)
envelopeId (string)
data: {
. assertionId (string)
. authenticationInstant (string)
. authenticationMethod (string)
. clientURLs
. clientUserId (string)
. displayFormat (string)
. email (string)
. frameAncestors (array)
. messageOrigins (array)
. pingFrequency (string)
. pingUrl (string)
. recipientId (string)
. returnUrl (string)
. securityDomain (string)
. userId (string)
. userName (string)
. xFrameOptions (string)
. xFrameOptionsAllowFromUrl (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflowReturns the workflow definition for the envelope specified by envelopeId. If the envelope does not have a workflow object, this method returns a 404.accountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflowUpdates the specified envelope's workflow. You can use this endpoint to add scheduled sending to a draft envelope. You can also update the scheduled sending for a sent envelope if the scheduled sending countdown is in progress. In that case, the envelope will be reset to a draft state. You can also add delayed routing to a draft envelope or a sent envelope that has not started workflow processing.accountId (string)
envelopeId (string)
data: {
. currentWorkflowStepId (string)
. resumeDate (string)
. scheduledSending
. workflowStatus (string)
. workflowSteps (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflowDeletes the specified envelope's workflow definition if it has one. Note: If the envelope was scheduled to be sent, this endpoint will cancel the scheduled send and the envelope status will be reset to created. To resend the envelope, call the update the status to sent with the Envelopes::Update/docs/esign-rest-api/reference/envelopes/envelopes/update/ method.accountId (string)
envelopeId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_scheduled_sendingGiven a template and a workflow step, returns the scheduled sending rules for that workflow step. Note: If the workflow step does not have a scheduled sending object, this method returns a 404.accountId (string)
envelopeId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_scheduled_sendingUpdates the scheduled sending rules for an envelope's workflow. The envelope must have an existing workflow object.accountId (string)
envelopeId (string)
data: {
. bulkListId (string)
. resumeDate (string)
. rules (array)
. status (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_scheduled_sendingDeletes the scheduled sending rules for an envelope's workflow. You cannot call this endpoint once the scheduled sending countdown has begun.accountId (string)
envelopeId (string)
esignature/post_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_stepsAdds a new step to an envelope's workflow.accountId (string)
envelopeId (string)
data: {
. action (string)
. completedDate (string)
. delayedRouting
. itemId (string)
. recipientRouting
. status (string)
. triggeredDate (string)
. triggerOnItem (string)
. workflowStepId (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_steps_by_workflow_step_idReturns a workflow step specified by workflowStepId for an envelope specified by envelopeId.accountId (string)
envelopeId (string)
workflowStepId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_steps_by_workflow_step_idUpdates the workflow step specified by workflowStepId for an envelope. You can use this endpoint to add or update delayed routing for a draft envelope. You can add or update delayed routing for a sent envelope as long as the previous workflow step has not been completed.accountId (string)
envelopeId (string)
workflowStepId (string)
data: {
. action (string)
. completedDate (string)
. delayedRouting
. itemId (string)
. recipientRouting
. status (string)
. triggeredDate (string)
. triggerOnItem (string)
. workflowStepId (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_steps_by_workflow_step_idDeletes the workflow step specified by workflowStepId from an envelope specified by envelopeId.accountId (string)
envelopeId (string)
workflowStepId (string)
esignature/get_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_steps_by_workflow_step_id_delayed_routingGiven an envelope and a workflow step, returns the delayed routing rules for that workflow step. Note: If the workflow step does not have a delayed routing object, this method returns a 404.accountId (string)
envelopeId (string)
workflowStepId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_steps_by_workflow_step_id_delayed_routingUpdates the delayed routing rules for an envelope's workflow step definition. You can use this endpoint to add delayed routing to a draft envelope or a sent envelope as long as the previous workflow step has not yet been completed. You can also update the delayed routing rule for an envelope, as long as the delay is not yet complete. If you update the delayed routing rule while the delay is already in progress, the countdown will reset.accountId (string)
envelopeId (string)
workflowStepId (string)
data: {
. resumeDate (string)
. rules (array)
. status (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_by_envelope_id_workflow_steps_by_workflow_step_id_delayed_routingDelete the delayed routing object for an envelope's workflow step. You cannot call this endpoint once the delay is in progress. As a workaround, you can update the delay or send time to one minute in the future using the updateEnvelopeDelayedRoutingDefinition/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateEnvelopeDelayedRoutingDefinition/ endpoint. Note: After deleting the delayed routing object, the workflow step still contains the pause_before action. Once the workfaccountId (string)
envelopeId (string)
workflowStepId (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_statusRetrieves envelope statuses for a set of envelopes. Envelopes: listStatus has both a GET and a PUT implementation: PUT /restapi/v2.1/accounts/accountId/envelopes/status is passed a set of envelope IDs in the request body. This version of the method returns a smaller subset of envelope information. GET /restapi/v2.1/accounts/accountId/envelopes/status is passed a list of envelope IDs in a query string. ds-inlinemessage To search for envelopes using a broad range of filters, use a href='/docs/eaccountId (string)
ac_status (string)
block (string)
count (string)
email (string)
envelope_ids (string)
from_date (string)
from_to_status (string)
start_position (string)
status (string)
to_date (string)
transaction_ids (string)
user_name (string)
data: {
. envelopeIds (array)
. transactionIds (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_envelopes_transfer_rulesThis method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.accountId (string)
count (string)
start_position (string)
esignature/put_v2_1_accounts_by_account_id_envelopes_transfer_rulesThis method changes the status for one or more envelope transfer rules based on the envelopeTransferRuleIds in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.accountId (string)
data: {
. endPosition (string)
. envelopeTransferRules (array)
. nextUri (string)
. previousUri (string)
. resultSetSize (string)
. startPosition (string)
. totalSetSize (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_envelopes_transfer_rulesThis method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - eventType - fromGroups - toUser - toFolder - carbonCopyOriginalOwner - enabled Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.accountId (string)
data: {
. carbonCopyOriginalOwner (string)
. enabled (string)
. envelopeTransferRuleId (string)
. eventType (string)
. fromGroups (array)
. fromUsers (array)
. modifiedDate (string)
. modifiedUser
. toFolder
. toUser
} (object) required
esignature/put_v2_1_accounts_by_account_id_envelopes_transfer_rules_by_envelope_transfer_rule_idThis method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the envelopeTransferRuleId both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.accountId (string)
envelopeTransferRuleId (string)
data: {
. carbonCopyOriginalOwner (string)
. enabled (string)
. envelopeTransferRuleId (string)
. eventType (string)
. fromGroup
. fromUser
. modifiedDate (string)
. modifiedUser
. toFolder
. toUser
} (object) required
esignature/delete_v2_1_accounts_by_account_id_envelopes_transfer_rules_by_envelope_transfer_rule_idThis method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.accountId (string)
envelopeTransferRuleId (string)
esignature/get_v2_1_accounts_by_account_id_favorite_templatesRetrieves the list of favorite templates for the account.accountId (string)
esignature/put_v2_1_accounts_by_account_id_favorite_templatesSet one or more templates as account favorites. Your request should include each template as a separate favoriteTemplatesContentItem JSON object, like this: 'favoriteTemplates': 'templateId': '6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1' , 'templateId': '8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f'accountId (string)
data: {
. errorDetails
. favoriteTemplates (array)
. templatesUpdatedCount (integer)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_favorite_templatesRemove one or more templates from the account favorites. Your request should include each template to remove as a separate favoriteTemplatesContentItem JSON object, like this: 'favoriteTemplates': 'templateId': '6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1' , 'templateId': '8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f' The response includes the IDs of the templates that were successfully removed from your favorites. To get the account'saccountId (string)
data: {
. errorDetails
. favoriteTemplates (array)
. templatesUpdatedCount (integer)
} (object) required
esignature/get_v2_1_accounts_by_account_id_foldersReturns a list of the account's folders. Use the include query parameter to specify the kinds of folders to return. By default, only the first level of subfolders is shown. Set the sub_folder_depth query parameter to -1 to return the entire folder hierarchy. ds-column ds-step open='false' hideIcon='true' Default returns only top-level folders. Click to show. div GET 'https://demo.docusign.net/restapi/v2.1/accounts/624e3e00-xxxx-xxxx-xxxx-43918c520dab/folders' json 'resultSetSize': 'accountId (string)
count (string)
include (string)
include_items (string)
start_position (string)
sub_folder_depth (string)
template (string)
user_filter (string)
esignature/get_v2_1_accounts_by_account_id_folders_by_folder_idGets information about items in the specified folder. To include a list of the items in the folder, set the include_items query parameter to true. Related topics - Searching for envelopes/docs/esign-rest-api/esign101/concepts/envelopes/search/ - Sharing templates/docs/esign-rest-api/esign101/concepts/templates/sharing/accountId (string)
folderId (string)
from_date (string)
include_items (string)
owner_email (string)
owner_name (string)
search_text (string)
start_position (string)
status (string)
to_date (string)
esignature/put_v2_1_accounts_by_account_id_folders_by_folder_idMoves a set of envelopes from their current folder to another folder. The folderId path parameter is the destination folder. The request body has an array of envelope IDs and the ID of the source folder. ds-inlinemessage kind='warning' markdown='1' Do not use the codefolders/code property in the request body. /ds-inlinemessage If folderId is the special value recyclebin the envelopes are moved to the Deleted folder. Moving an in-process envelope envelope status of sent or delivered to the raccountId (string)
folderId (string)
data: {
. envelopeIds (array)
. folders (array)
. fromFolderId (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_groupsGets information about groups associated with the account. ds-inlinemessage kind='information' markdown='1' To get the users in a group: 1. Use this endpoint to get the group ID. 2. Use listGroupUsers/docs/esign-rest-api/reference/usergroups/groupusers/list/ to get the list of users. /ds-inlinemessage Related topics - How to set a permission profile/docs/esign-rest-api/how-to/permission-profile-setting/accountId (string)
count (string)
group_type (string)
include_usercount (string)
search_text (string)
start_position (string)
esignature/put_v2_1_accounts_by_account_id_groupsUpdates the group name and modifies, or sets, the permission profile for the group. Related topics - How-To Set Up a Permission Profile/docs/esign-rest-api/how-to/permission-profile-setting/accountId (string)
data: {
. endPosition (string)
. groups (array)
. nextUri (string)
. previousUri (string)
. resultSetSize (string)
. startPosition (string)
. totalSetSize (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_groupsCreates one or more groups for the account. Groups help you manage users. For example, you can use groups to limit user access to templates. You can associate a group with a permission profile/docs/esign-rest-api/esign101/concepts/permissions/, which sets the user permissions for users in that group without having to set the userSettings property for each user. You are not required to set permission profiles for a group, but it makes it easier to manage user permissions for a large number of uaccountId (string)
data: {
. endPosition (string)
. groups (array)
. nextUri (string)
. previousUri (string)
. resultSetSize (string)
. startPosition (string)
. totalSetSize (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_groupsDeletes an existing user group. When you delete a group, you include only the groupId in the request body. Example: 'groups': 'groupId': '12345'accountId (string)
data: {
. endPosition (string)
. groups (array)
. nextUri (string)
. previousUri (string)
. resultSetSize (string)
. startPosition (string)
. totalSetSize (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_groups_by_group_id_brandsThis method returns information about the brands associated with a group.accountId (string)
groupId (string)
esignature/put_v2_1_accounts_by_account_id_groups_by_group_id_brandsThis method adds one or more existing brands to a group based on the groupId.accountId (string)
groupId (string)
data: {
. brands (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_groups_by_group_id_brandsThis method deletes one or more brands from a group.accountId (string)
groupId (string)
data: {
. brands (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_groups_by_group_id_usersRetrieves a list of users in a group.accountId (string)
groupId (string)
count (string)
start_position (string)
esignature/put_v2_1_accounts_by_account_id_groups_by_group_id_usersAdds one or more existing Docusign users to an existing group.accountId (string)
groupId (string)
data: {
. users (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_groups_by_group_id_usersDeletes one or more users from a group. This request takes a userInfoList that contains the users that you want to delete.accountId (string)
groupId (string)
data: {
. users (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_identity_verificationThis method returns a list of Identity Verification workflows that are available to an account. Note: To use this method, you must either be an account administrator or a sender. Related topics - How to require ID Verification IDV for a recipient/docs/esign-rest-api/how-to/id-verification/accountId (string)
identity_verification_workflow_status (string)
esignature/get_v2_1_accounts_by_account_id_payment_gateway_accountsThis method returns a list of payment gateway accounts and basic information about them.accountId (string)
esignature/get_v2_1_accounts_by_account_id_permission_profilesThis method returns a list of permission profiles that are associated with an account. Example: json 'permissionProfiles': 'permissionProfileId': '1665536', 'permissionProfileName': 'Account Administrator', 'modifiedDateTime': '2018-03-26T03:54:40.4470000Z', 'modifiedByUsername': '' , 'permissionProfileId': '1665537', 'permissionProfileName': 'DocuSign Sender', 'modifiedDateTime': '2018-03-26T03:54:40.4470000Z', 'modifiedByUsernaccountId (string)
include (string)
esignature/post_v2_1_accounts_by_account_id_permission_profilesThis method creates a new permission profile for an account. Related topics - How to create a permission profile/docs/esign-rest-api/how-to/permission-profile-creating/accountId (string)
include (string)
data: {
. modifiedByUsername (string)
. modifiedDateTime (string)
. permissionProfileId (string)
. permissionProfileName (string)
. settings
. userCount (string)
. users (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_permission_profiles_by_permission_profile_idThis method returns information about a specific permission profile that is associated with an account. Related topics - How to set a permission profile/docs/esign-rest-api/how-to/permission-profile-setting/accountId (string)
permissionProfileId (string)
include (string)
esignature/put_v2_1_accounts_by_account_id_permission_profiles_by_permission_profile_idThis method updates an account permission profile. Related topics - How to update individual permission settings/docs/esign-rest-api/how-to/permission-profile-updating/accountId (string)
permissionProfileId (string)
include (string)
data: {
. modifiedByUsername (string)
. modifiedDateTime (string)
. permissionProfileId (string)
. permissionProfileName (string)
. settings
. userCount (string)
. users (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_permission_profiles_by_permission_profile_idThis method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the move_users_to query parameter. Related topics - How to delete a permission profile/docs/esign-rest-api/how-to/permission-profile-deleting/accountId (string)
permissionProfileId (string)
move_users_to (string)
esignature/get_v2_1_accounts_by_account_id_powerformsThis method returns a list of PowerForms that are available to the user.accountId (string)
count (string)
from_date (string)
order (string)
order_by (string)
search_fields (string)
search_text (string)
start_position (string)
to_date (string)
esignature/post_v2_1_accounts_by_account_id_powerformsThis method creates a new PowerForm. You create a PowerForm from an existing Docusign template/docs/esign-rest-api/reference/templates/templates/create/, based on the templateId in the request body. PowerForms that you create from a template are referred to as web PowerForms. Note: The Docusign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields referred to as a PDF PowerForm. However, PDF PowerForms are deprecated and are not supported in theaccountId (string)
data: {
. createdBy (string)
. createdDateTime (string)
. emailBody (string)
. emailSubject (string)
. envelopes (array)
. errorDetails
. instructions (string)
. isActive (string)
. lastUsed (string)
. limitUseInterval (string)
. limitUseIntervalEnabled (string)
. limitUseIntervalUnits (string)
. maxUseEnabled (string)
. name (string)
. powerFormId (string)
. powerFormUrl (string)
. recipients (array)
. senderName (string)
. senderUserId (string)
. signingMode (string)
. templateId (string)
. templateName (string)
. timesUsed (string)
. uri (string)
. usesRemaining (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_powerformsThis method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the powerFormId.accountId (string)
data: {
. powerForms (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_powerforms_by_power_form_idThis method returns detailed information about a specific PowerForm.accountId (string)
powerFormId (string)
esignature/put_v2_1_accounts_by_account_id_powerforms_by_power_form_idThis method updates an existing PowerForm.accountId (string)
powerFormId (string)
data: {
. createdBy (string)
. createdDateTime (string)
. emailBody (string)
. emailSubject (string)
. envelopes (array)
. errorDetails
. instructions (string)
. isActive (string)
. lastUsed (string)
. limitUseInterval (string)
. limitUseIntervalEnabled (string)
. limitUseIntervalUnits (string)
. maxUseEnabled (string)
. name (string)
. powerFormId (string)
. powerFormUrl (string)
. recipients (array)
. senderName (string)
. senderUserId (string)
. signingMode (string)
. templateId (string)
. templateName (string)
. timesUsed (string)
. uri (string)
. usesRemaining (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_powerforms_by_power_form_idThis method deletes a PowerForm.accountId (string)
powerFormId (string)
esignature/get_v2_1_accounts_by_account_id_powerforms_by_power_form_id_form_dataThis method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the Accept header. This header accepts the following values: - application/json: JSON format - application/xml: XML format - text/csv: Comma-separated value CSV format You can further specify the type of CSV format in the data_layout query parameter. Note: Only PowerForm Administrators oraccountId (string)
powerFormId (string)
data_layout (string)
from_date (string)
to_date (string)
esignature/get_v2_1_accounts_by_account_id_powerforms_sendersThis method returns a list of users who have sent PowerForms.accountId (string)
start_position (string)
esignature/get_v2_1_accounts_by_account_id_recipient_namesRetrieves a list of all of the names associated with the email address that you pass in. This list can include variants of a single recipient's name that are used for signing, as well as the names of multiple different recipients.accountId (string)
email (string)
esignature/get_v2_1_accounts_by_account_id_sealsReturns available seals for specified account.accountId (string)
esignature/get_v2_1_accounts_by_account_id_search_folders_by_search_folder_idds-inlinemessage kind='warning' markdown='1' strongThis method is deprecated in API v2.1/strong Use Envelopes: listStatusChanges/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/ instead. /ds-inlinemessage Retrieves a list of items that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.accountId (string)
searchFolderId (string)
all (string)
count (string)
from_date (string)
include_recipients (string)
order (string)
order_by (string)
start_position (string)
to_date (string)
esignature/get_v2_1_accounts_by_account_id_settingsRetrieves the account settings information for the specified account.accountId (string)
esignature/put_v2_1_accounts_by_account_id_settingsUpdates the account settings for the specified account. Although the request body for this method is a complete accountSettingsInformation object, you only need to provide the properties that you are updating.accountId (string)
data: {
. accessCodeFormat
. accountDateTimeFormat (string)
. accountDateTimeFormatMetadata
. accountDefaultLanguage (string)
. accountDefaultLanguageMetadata
. accountName (string)
. accountNameMetadata
. accountNotification
. accountUISettings
. adoptSigConfig (string)
. adoptSigConfigMetadata
. advancedCorrect (string)
. advancedCorrectMetadata
. advancedSearchEnableTabField (string)
. advancedSearchEnableTabFieldMetadata
. advancedSearchEnableTemplateIdField (string)
. advancedSearchEnableTemplateIdFieldMetadata
. advancedSearchEnableTemplateNameField (string)
. advancedSearchEnableTemplateNameFieldMetadata
. allowAccessCodeFormat (string)
. allowAccessCodeFormatMetadata
. allowAccountManagementGranular (string)
. allowAccountManagementGranularMetadata
. allowAccountMemberNameChange (string)
. allowAccountMemberNameChangeMetadata
. allowACE (string)
. allowACEMetadata
. allowAdvancedRecipientRoutingConditional (string)
. allowAdvancedRecipientRoutingConditionalMetadata
. allowAgentNameEmailEdit (string)
. allowAgentNameEmailEditMetadata
. allowAgreementActions (string)
. allowAgreementActionsMetadata
. allowAgreementOrchestrations (string)
. allowAgreementOrchestrationsMetadata
. allowAutoNavSettings (string)
. allowAutoNavSettingsMetadata
. allowAutoTagging (string)
. allowAutoTaggingMetadata
. allowBulkSend (string)
. allowBulkSendMetadata
. allowBYOIDV (string)
. allowBYOIDVMetadata
. allowCDWithdraw (string)
. allowCDWithdrawMetadata
. allowConnectAgreementUI (string)
. allowConnectAgreementUIMetadata
. allowConnectAuthoritativeCopyReadyEventUI (string)
. allowConnectEnvelopeReminderSentEventUI (string)
. allowConnectEnvelopeRemovedEvent (string)
. allowConnectExtensionUI (string)
. allowConnectHttpListenerConfigs (string)
. AllowConnectIdentityVerificationUI (string)
. allowConnectOAuthUI (string)
. allowConnectSendFinishLater (string)
. allowConnectSendFinishLaterMetadata
. allowConnectUnifiedPayloadUI (string)
. allowConsumerDisclosureOverride (string)
. allowConsumerDisclosureOverrideMetadata
. allowDataDownload (string)
. allowDataDownloadMetadata
. allowDelayedRouting (string)
. allowDelayedRoutingMetadata
. allowDelegatedSigning (string)
. allowDelegatedSigningMetadata
. allowDocGenDocuments (string)
. allowDocGenDocumentsMetadata
. allowDocumentDisclosures (string)
. allowDocumentDisclosuresMetadata
. allowDocumentsOnSignedEnvelopes (string)
. allowDocumentsOnSignedEnvelopesMetadata
. allowDocumentVisibility (string)
. allowDocumentVisibilityMetadata
. allowEditingEnvelopesOnBehalfOfOthers (string)
. allowEditingEnvelopesOnBehalfOfOthersMetadata
. allowEHankoStamps (string)
. allowEHankoStampsMetadata
. allowENoteEOriginal (string)
. allowENoteEOriginalMetadata
. allowEnvelopeCorrect (string)
. allowEnvelopeCorrectMetadata
. allowEnvelopeCustodyTransfer (string)
. allowEnvelopeCustodyTransferMetadata
. allowEnvelopeCustomFields (string)
. allowEnvelopeCustomFieldsMetadata
. allowEnvelopePublishReporting (string)
. allowEnvelopePublishReportingMetadata
. allowEnvelopeReporting (string)
. allowEnvelopeReportingMetadata
. allowExpression (string)
. allowExpressionMetadata
. allowExpressSignerCertificate (string)
. allowExpressSignerCertificateMetadata
. allowExtendedSendingResourceFile (string)
. allowExtendedSendingResourceFileMetadata
. allowExternalLinkedAccounts (string)
. allowExternalLinkedAccountsMetadata
. allowExternalSignaturePad (string)
. allowExternalSignaturePadMetadata
. allowFedRampIDVLevel1 (string)
. allowFedRampIDVLevel1Metadata
. allowFedRampIDVLevel2 (string)
. allowFedRampIDVLevel2Metadata
. allowIDVForEUQualifiedSignatures (string)
. allowIDVForEUQualifiedSignaturesMetadata
. allowIDVLevel1 (string)
. allowIDVLevel1Metadata
. allowIDVLevel1Trial (string)
. allowIDVLevel1TrialMetadata
. allowIDVLevel2 (string)
. allowIDVLevel2Metadata
. allowIDVLevel3 (string)
. allowIDVLevel3Metadata
. allowIDVPlatform (string)
. allowIDVPlatformMetadata
. allowIdvRiskAssessment (string)
. allowIdvRiskAssessmentMetadata
. allowInPerson (string)
. allowInPersonElectronicNotary (string)
. allowInPersonElectronicNotaryMetadata
. allowInPersonMetadata
. allowManagedStamps (string)
. allowManagedStampsMetadata
. allowManagingEnvelopesOnBehalfOfOthers (string)
. allowManagingEnvelopesOnBehalfOfOthersMetadata
. allowMarkup (string)
. allowMarkupMetadata
. allowMemberTimeZone (string)
. allowMemberTimeZoneMetadata
. allowMergeFields (string)
. allowMergeFieldsMetadata
. allowMultipleBrandProfiles (string)
. allowMultipleBrandProfilesMetadata
. allowMultipleSignerAttachments (string)
. allowMultipleSignerAttachmentsMetadata
. allowNonUSPhoneAuth (string)
. allowNonUSPhoneAuthMetadata
. allowOcrOfEnvelopeDocuments (string)
. allowOcrOfEnvelopeDocumentsMetadata
. allowOfflineSigning (string)
. allowOfflineSigningMetadata
. allowOnlyStandaloneWebForms (string)
. allowOnlyStandaloneWebFormsMetadata
. allowOpenTrustSignerCertificate (string)
. allowOpenTrustSignerCertificateMetadata
. allowOrganizationBranding (string)
. allowOrganizationBrandingMetadata
. allowOrganizationDocusignMonitor (string)
. allowOrganizationDocusignMonitorFree (string)
. allowOrganizationDocusignMonitorFreeMetadata
. allowOrganizationDocusignMonitorMetadata
. allowOrganizationDomainUserManagement (string)
. allowOrganizationDomainUserManagementMetadata
. allowOrganizations (string)
. allowOrganizationsMetadata
. allowOrganizationSsoManagement (string)
. allowOrganizationSsoManagementMetadata
. allowOrganizationToUseInPersonElectronicNotary (string)
. allowOrganizationToUseInPersonElectronicNotaryMetadata
. allowOrganizationToUseRemoteNotary (string)
. allowOrganizationToUseRemoteNotaryMetadata
. allowOrganizationToUseThirdPartyElectronicNotary (string)
. allowOrganizationToUseThirdPartyElectronicNotaryMetadata
. allowParticipantRecipientType (string)
. allowParticipantRecipientTypeMetadata
. allowPaymentProcessing (string)
. allowPaymentProcessingMetadata
. allowPendingDestinationUrlEdition (string)
. allowPendingDestinationUrlEditionMetadata
. allowPerformanceAnalytics (string)
. allowPerformanceAnalyticsMetadata
. allowPhoneAuthentication (string)
. allowPhoneAuthenticationMetadata
. allowPhoneAuthOverride (string)
. allowPhoneAuthOverrideMetadata
. allowPrivateSigningGroups (string)
. allowPrivateSigningGroupsMetadata
. allowRecipientConnect (string)
. allowRecipientConnectMetadata
. allowReminders (string)
. allowRemindersMetadata
. allowRemoteNotary (string)
. allowRemoteNotaryMetadata
. allowResourceFileBranding (string)
. allowResourceFileBrandingMetadata
. allowSafeBioPharmaSignerCertificate (string)
. allowSafeBioPharmaSignerCertificateMetadata
. allowScheduledSending (string)
. allowScheduledSendingMetadata
. allowSecurityAppliance (string)
. allowSecurityApplianceMetadata
. allowSendingEnvelopesOnBehalfOfOthers (string)
. allowSendingEnvelopesOnBehalfOfOthersMetadata
. allowSendToCertifiedDelivery (string)
. allowSendToCertifiedDeliveryMetadata
. allowSendToIntermediary (string)
. allowSendToIntermediaryMetadata
. allowServerTemplates (string)
. allowServerTemplatesMetadata
. allowSetEmbeddedRecipientStartURL (string)
. allowSetEmbeddedRecipientStartURLMetadata
. allowSharedTabs (string)
. allowSharedTabsMetadata
. allowSignatureStamps (string)
. allowSignatureStampsMetadata
. allowSignDocumentFromHomePage (string)
. allowSignDocumentFromHomePageMetadata
. allowSignerReassign (string)
. allowSignerReassignMetadata
. allowSignerReassignOverride (string)
. allowSignerReassignOverrideMetadata
. allowSigningExtensions (string)
. allowSigningExtensionsMetadata
. allowSigningGroups (string)
. allowSigningGroupsMetadata
. allowSigningInsights (string)
. allowSigningInsightsMetadata
. allowSigningRadioDeselect (string)
. allowSigningRadioDeselectMetadata
. allowSignNow (string)
. allowSignNowMetadata (string)
. allowSMSDelivery (string)
. allowSMSDeliveryMetadata
. allowSocialIdLogin (string)
. allowSocialIdLoginMetadata
. allowSupplementalDocuments (string)
. allowSupplementalDocumentsMetadata
. allowThirdPartyElectronicNotary (string)
. allowThirdPartyElectronicNotaryMetadata
. allowTransactionsWorkspace (string)
. allowTransactionsWorkspaceMetadata
. allowTransactionsWorkspaceOriginal (string)
. allowTransactionsWorkspaceOriginalMetadata
. allowUsersToAccessDirectory (string)
. allowUsersToAccessDirectoryMetadata
. allowValueInsights (string)
. allowValueInsightsMetadata
. allowWebForms (string)
. allowWebFormsMetadata
. allowWhatsAppDelivery (string)
. allowWhatsAppDeliveryMetadata
. anchorPopulationScope (string)
. anchorPopulationScopeMetadata
. anchorTagVersionedPlacementEnabled (string)
. anchorTagVersionedPlacementMetadataEnabled
. attachCompletedEnvelope (string)
. attachCompletedEnvelopeMetadata
. authenticationCheck (string)
. authenticationCheckMetadata
. autoNavRule (string)
. autoNavRuleMetadata
. autoProvisionSignerAccount (string)
. autoProvisionSignerAccountMetadata
. bccEmailArchive (string)
. bccEmailArchiveMetadata
. betaSwitchConfiguration (string)
. betaSwitchConfigurationMetadata
. billingAddress
. billingAddressMetadata
. bulkSend (string)
. bulkSendActionResendLimit (string)
. bulkSendMaxCopiesInBatch (string)
. bulkSendMaxUnprocessedEnvelopesCount (string)
. bulkSendMetadata
. canSelfBrandSend (string)
. canSelfBrandSendMetadata
. canSelfBrandSign (string)
. canSelfBrandSignMetadata
. canUseSalesforceOAuth (string)
. canUseSalesforceOAuthMetadata
. captureVoiceRecording (string)
. captureVoiceRecordingMetadata
. cfr21SimplifiedSigningEnabled (string)
. cfr21SimplifiedSigningEnabledMetadata
. cfrUseWideImage (string)
. cfrUseWideImageMetadata
. checkForMultipleAdminsOnAccount (string)
. checkForMultipleAdminsOnAccountMetadata
. chromeSignatureEnabled (string)
. chromeSignatureEnabledMetadata
. cloudReady (string)
. commentEmailShowMessageText (string)
. commentEmailShowMessageTextMetadata
. commentsAllowEnvelopeOverride (string)
. commentsAllowEnvelopeOverrideMetadata
. conditionalFieldsEnabled (string)
. conditionalFieldsEnabledMetadata
. consumerDisclosureFrequency (string)
. consumerDisclosureFrequencyMetadata
. convertPdfFields (string)
. convertPdfFieldsMetadata
. customExtractionPlanLevels (string)
. customExtractionPlanLevelsMetadata
. dataPopulationScope (string)
. dataPopulationScopeMetadata
. defaultSigningResponsiveView (string)
. defaultSigningResponsiveViewMetadata
. defaultSigningResponsiveViewUseGrade (string)
. defaultSigningResponsiveViewUseGradeMetadata
. defaultToAdvancedEnvelopesFilterForm (string)
. defaultToAdvancedEnvelopesFilterFormMetadata
. disableAutoTemplateMatching (string)
. disableAutoTemplateMatchingMetadata
. disableLegacyKba (string)
. disableLegacyKbaMetadata
. disableLegacySharedEnvelopes (string)
. disableLegacySharedEnvelopesMetadata
. disableMobileApp (string)
. disableMobileAppMetadata
. disableMobilePushNotifications (string)
. disableMobilePushNotificationsMetadata
. disableMobileSending (string)
. disableMobileSendingMetadata
. disableMultipleSessions (string)
. disableMultipleSessionsMetadata
. disablePurgeNotificationsForSenderMetadata
. disableSignerCertView (string)
. disableSignerCertViewMetadata
. disableSignerHistoryView (string)
. disableSignerHistoryViewMetadata
. disableStyleSignature (string)
. disableStyleSignatureMetadata
. disableUploadSignature (string)
. disableUploadSignatureMetadata
. disableUserSharing (string)
. disableUserSharingMetadata
. displayBetaSwitch (string)
. displayBetaSwitchMetadata
. documentConversionRestrictions (string)
. documentConversionRestrictionsMetadata
. documentRetention (string)
. documentRetentionMetadata
. documentRetentionPurgeTabs (string)
. documentVisibility (string)
. documentVisibilityMetadata
. draftEnvelopeRetention (string)
. draftEnvelopeRetentionMetadata
. dss_SIGN_28411_EnableLeavePagePrompt_RadminOption (string)
. dss_SIGN_29182_SlideUpBar_RadminOption (string)
. emailTemplateVersion (string)
. emailTemplateVersionMetadata
. enableAccessCodeGenerator (string)
. enableAccessCodeGeneratorMetadata
. enableAccountWideSearch (string)
. enableAccountWideSearchMetadata
. enableAdditionalAdvancedWebFormsFeatures (string)
. enableAdditionalAdvancedWebFormsFeaturesMetadata
. enableAdmHealthcare (string)
. enableAdmHealthcareMetadata
. enableAdvancedEnvelopesSearch (string)
. enableAdvancedEnvelopesSearchMetadata
. enableAdvancedPayments (string)
. enableAdvancedPaymentsMetadata
. enableAdvancedPowerForms (string)
. enableAdvancedPowerFormsMetadata
. enableAdvancedSearch (string)
. enableAdvancedSearchMetadata
. enableAgreementActionsForCLM (string)
. enableAgreementActionsForCLMMetadata
. enableAgreementActionsForESign (string)
. enableAgreementActionsForESignMetadata
. enableAgreementDeskAdvanced (string)
. enableAgreementDeskAdvancedMetaData
. enableAIContractReview (string)
. enableAIContractReviewMetadata
. enableAISenderMessage (string)
. enableAISenderMessageMetadata
. enableAISuggestedFields (string)
. enableAISuggestedFieldsAutoPlace (string)
. enableAISuggestedFieldsAutoPlaceMetadata
. enableAISuggestedFieldsMetadata
. enableAutoNav (string)
. enableAutoNavMetadata
. enableBatchUpdateEnvelopeTypes (string)
. enableBatchUpdateEnvelopeTypesMetadata
. enableBccDummyLink (string)
. enableBccDummyLinkMetadata
. enableCalculatedFields (string)
. enableCalculatedFieldsMetadata
. enableCFRRapidSigningEmbeddedAuth (string)
. enableCFRRapidSigningEmbeddedAuthMetadata
. enableClickPlus (string)
. enableClickPlusConditionalContent (string)
. enableClickPlusConditionalContentMetaData
. enableClickPlusCustomFields (string)
. enableClickPlusCustomFieldsMetaData
. enableClickPlusCustomStyle (string)
. enableClickPlusCustomStyleMetaData
. enableClickPlusDynamicContent (string)
. enableClickPlusDynamicContentMetaData
. enableClickPlusMetaData
. enableClickwraps (string)
. enableClickwrapsMetadata
. enableCombinedPDFDownloadForSBS (string)
. enableCommentsHistoryDownloadInSigning (string)
. enableCommentsHistoryDownloadInSigningMetadata
. enableContactSuggestions (string)
. enableContactSuggestionsMetadata
. enableContentSearch (string)
. enableContentSearchMetadata
. enableCoupaCoreExtension (string)
. enableCoupaCoreExtensionMetadata
. enableCustomDataVerificationExtensions (string)
. enableCustomDataVerificationExtensionsMetadata
. enableCustomerSatisfactionMetricTracking (string)
. enableCustomerSatisfactionMetricTrackingMetadata
. enableDataVerificationExtensions (string)
. enableDataVerificationExtensionsMetadata
. enableDocumentTemplateLibrary (string)
. enableDocumentTemplateLibraryMetadata
. enableDSigEUAdvancedPens (string)
. enableDSigEUAdvancedPensMetadata
. enableDSigExpressPens (string)
. enableDSigExpressPensMetadata
. enableDSigIDCheckForAESPens (string)
. enableDSigIDCheckForAESPensMetadata
. enableDSigIDCheckInPersonForQESPens (string)
. enableDSigIDCheckInPersonForQESPensMetadata
. enableDSigIDCheckRemoteForQESPens (string)
. enableDSigIDCheckRemoteForQESPensMetadata
. enableDSigIDVerificationPens (string)
. enableDSigIDVerificationPensMetadata
. enableDSigIDVerificationPremierPens (string)
. enableDSigIDVerificationPremierPensMetadata
. enableDSigPenGroupEuQes (string)
. enableDSigPenGroupEuQesMetadata
. enableDSigPlgEuQesPens (string)
. enableDSigPlgEuQesPensMetadata
. enableDSPro (string)
. enableDSProMetadata
. enableEnforceTlsEmailsSettingMetadata
. enableEnvelopeStampingByAccountAdmin (string)
. enableEnvelopeStampingByAccountAdminMetadata
. enableEnvelopeStampingByDSAdmin (string)
. enableEnvelopeStampingByDSAdminMetadata
. enableESignAPIHourlyLimitManagement (string)
. enableESignAPIHourlyLimitManagementMetadata
. enableEsignCommunities (string)
. enableEsignCommunitiesMetadata
. enableEsignTaskList (string)
. enableEsignTaskListMetadata
. enableGenerationWith3PIntegration (string)
. enableGenerationWith3PIntegrationMetaData
. enableIDFxAccountlessSMSAuthForPart11 (string)
. enableIDFxAccountlessSMSAuthForPart11Metadata
. enableIDFxIntuitKBA (string)
. enableIDFxIntuitKBAMetadata
. enableIDFxPhoneAuthentication (string)
. enableIDFxPhoneAuthenticationMetadata
. enableIdfxPhoneAuthSignatureAuthStatus (string)
. enableIdfxPhoneAuthSignatureAuthStatusMetadata
. enableInboxBrowseViewsPoweredByElasticSearch (string)
. enableInboxBrowseViewsPoweredByElasticSearchMetadata
. enableInboxRelevanceSort (string)
. enableInboxRelevanceSortMetadata
. enableInBrowserEditor (string)
. enableInBrowserEditorMetadata
. enableKeyTermsSuggestionsByDocumentType (string)
. enableKeyTermsSuggestionsByDocumentTypeMetadata
. enableLargeFileSupport (string)
. enableLargeFileSupportMetadata
. enableLegacySharedEnvelopes (string)
. enableLegacySharedEnvelopesMetadata
. enableLicenseManagement (string)
. enableLicenseManagementMetadata
. enableMicrosoftDynamics365Extension (string)
. enableMicrosoftDynamics365ExtensionMetadata
. enableMultiUserRepositoryFeatures (string)
. enableMultiUserRepositoryFeaturesMetadata
. enableNavigatorAPIDataIn (string)
. enableNavigatorAPIDataInMetadata
. enableNavigatorAPIDataOut (string)
. enableNavigatorAPIDataOutMetadata
. enableNavigatorAPIUtilities (string)
. enableNavigatorAPIUtilitiesMetadata
. enableNavigatorForHR (string)
. enableNavigatorForHRMetadata
. enableNavigatorHierarchyAI (string)
. enableNavigatorHierarchyAIMetadata
. enableNavigatorPartialIngestion (string)
. enableNavigatorPartialIngestionMetadata
. enableNavigatorTrial (string)
. enableNavigatorTrialMetadata
. enableNotaryOnDemandWitness (string)
. enableNotaryOnDemandWitnessMetadata
. enableObligationManagement (string)
. enableObligationManagementMetadata
. enableParticipantRecipientSettingMetadata
. enablePaymentProcessing (string)
. enablePaymentProcessingMetadata
. enablePDFAConversion (string)
. enablePDFAConversionMetadata
. enablePowerForm (string)
. enablePowerFormDirect (string)
. enablePowerFormDirectMetadata
. enablePowerFormMetadata
. enablePremiumDataVerificationExtensions (string)
. enablePremiumDataVerificationExtensionsMetadata
. enableRecipientDomainValidation (string)
. enableRecipientDomainValidationMetadata
. enableRecipientMayProvidePhoneNumber (string)
. enableRecipientMayProvidePhoneNumberMetadata
. enableReportLinks (string)
. enableReportLinksMetadata
. enableRequireSignOnPaper (string)
. enableRequireSignOnPaperMetadata
. enableReservedDomain (string)
. enableReservedDomainMetadata
. enableResponsiveSigning (string)
. enableResponsiveSigningMetadata
. enableSAPAribaExtension (string)
. enableSAPAribaExtensionMetaData
. enableScheduledRelease (string)
. enableScheduledReleaseMetadata
. enableSearchServiceAzureUri (string)
. enableSearchServiceAzureUriMetadata
. enableSearchSiteSpecificApi (string)
. enableSearchSiteSpecificApiMetadata
. enableSendingTagsFontSettings (string)
. enableSendingTagsFontSettingsMetadata
. enableSendToAgent (string)
. enableSendToAgentMetadata
. enableSendToIntermediary (string)
. enableSendToIntermediaryMetadata
. enableSendToManage (string)
. enableSendToManageMetadata
. enableSequentialSigningAPI (string)
. enableSequentialSigningAPIMetadata
. enableSequentialSigningUI (string)
. enableSequentialSigningUIMetadata
. enableSignerAttachments (string)
. enableSignerAttachmentsMetadata
. enableSigningAIFeaturesPlan (string)
. enableSigningAIFeaturesPlanMetadata
. enableSigningExtensionComments (string)
. enableSigningExtensionCommentsMetadata
. enableSigningExtensionConversations (string)
. enableSigningExtensionConversationsMetadata
. enableSigningGroupContinuePageSetting (string)
. enableSigningGroupContinuePageSettingMetadata
. enableSigningOrderSettingsForAccount (string)
. enableSigningOrderSettingsForAccountMetadata
. enableSignOnPaper (string)
. enableSignOnPaperMetadata
. enableSignOnPaperOverride (string)
. enableSignOnPaperOverrideMetadata
. enableSignWithNotary (string)
. enableSignWithNotaryMetadata
. enableSmartContracts (string)
. enableSmartContractsMetadata
. enableSMSAuthentication (string)
. enableSMSAuthenticationMetadata
. enableSMSDeliveryAdditionalNotification (string)
. enableSMSDeliveryAdditionalNotificationMetadata
. enableSMSDeliveryPrimary (string)
. enableSocialIdLogin (string)
. enableSocialIdLoginMetadata
. enableStrikeThrough (string)
. enableStrikeThroughMetadata
. enableTickets (string)
. enableTicketsMetaData
. enableTransactionPoint (string)
. enableTransactionPointMetadata
. enableUnifiedRepository (string)
. enableUnifiedRepositoryMetadata
. enableVaulting (string)
. enableVaultingMetadata
. enableWebFormsRuntimeAPIs (string)
. enableWebFormsRuntimeAPIsMetadata
. enableWebFormsSeparateUserPermissions (string)
. enableWebFormsSeparateUserPermissionsMetadata
. enableWitnessing (string)
. enableWitnessingMetadata
. enableWorkdayFinancialsExtension (string)
. enableWorkdayFinancialsExtensionMetaData
. enforceTemplateNameUniqueness (string)
. enforceTemplateNameUniquenessMetadata
. enforceTlsEmails (string)
. enforceTlsEmailsMetadata
. envelopeIntegrationAllowed (string)
. envelopeIntegrationAllowedMetadata
. envelopeIntegrationEnabled (string)
. envelopeIntegrationEnabledMetadata
. EnvelopeLimitsTotalDocumentSizeAllowedInMB (string)
. EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabled (string)
. EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata
. EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata
. envelopeSearchMode (string)
. envelopeSearchModeMetadata
. envelopeStampingDefaultValue (string)
. envelopeStampingDefaultValueMetadata
. exitPrompt (string)
. exitPromptMetadata
. expressSend (string)
. expressSendAllowTabs (string)
. expressSendAllowTabsMetadata
. expressSendMetadata
. externalDocumentSources
. externalSignaturePadType (string)
. externalSignaturePadTypeMetadata
. faxOutEnabled (string)
. faxOutEnabledMetadata
. finishReminder (string)
. finishReminderMetadata
. forbidAddingUserStamps (string)
. forbidAddingUserStampsMetadata
. guidedFormsHtmlAllowed (string)
. guidedFormsHtmlAllowedMetadata
. guidedFormsHtmlConversionPolicy (string)
. guidedFormsHtmlConversionPolicyMetadata
. hasRecipientConnectClaimedDomain (string)
. hideAccountAddressInCoC (string)
. hideAccountAddressInCoCMetadata
. hidePricing (string)
. hidePricingMetadata
. idCheckConfigurations (array)
. idCheckExpire (string)
. idCheckExpireDays (string)
. idCheckExpireDaysMetadata
. idCheckExpireMetadata
. idCheckExpireMinutes (string)
. idCheckExpireMinutesMetadata
. idCheckRequired (string)
. idCheckRequiredMetadata
. identityVerification (array)
. identityVerificationMetadata
. idfxKBAAuthenticationOverride (string)
. idfxKBAAuthenticationOverrideMetadata
. idfxPhoneAuthenticationOverride (string)
. idfxPhoneAuthenticationOverrideMetadata
. ignoreErrorIfAnchorTabNotFound (string)
. ignoreErrorIfAnchorTabNotFoundMetadataEnabled
. inPersonIDCheckQuestion (string)
. inPersonIDCheckQuestionMetadata
. inPersonSigningEnabled (string)
. inPersonSigningEnabledMetadata
. inSessionEnabled (string)
. inSessionEnabledMetadata
. inSessionSuppressEmails (string)
. inSessionSuppressEmailsMetadata
. isConnectDocumentFieldsEnabled (string)
. isvEmbed (string)
. isvEmbedMetaData
. isvOemEmbed (string)
. isvOemEmbedMetaData
. linkedExternalPrimaryAccounts (array)
. maestroPlanLevels (string)
. maestroPlanLevelsMetadata
. maximumSigningGroups (string)
. maximumSigningGroupsMetadata
. maximumUsersPerSigningGroup (string)
. maximumUsersPerSigningGroupMetadata
. maxNumberOfCustomStamps (string)
. mergeMixedModeResults (string)
. mergeMixedModeResultsMetadata
. mobileSessionTimeout (string)
. mobileSessionTimeoutMetadata
. numberOfActiveCustomStamps (string)
. optInMobileSigningV02 (string)
. optInMobileSigningV02Metadata
. optInUniversalSignatures (string)
. optOutAutoNavTextAndTabColorUpdates (string)
. optOutAutoNavTextAndTabColorUpdatesMetadata
. optOutNewPlatformSeal (string)
. optOutNewPlatformSealPlatformMetadata
. originalAccountSite (string)
. participantCopyOptOut (string)
. participantCopyOptOutMetadata
. pdfMaxChunkedUploadPartSize (string)
. pdfMaxChunkedUploadPartSizeMetadata
. pdfMaxChunkedUploadTotalSize (string)
. pdfMaxChunkedUploadTotalSizeMetadata
. pdfMaxIndividualUploadSize (string)
. pdfMaxIndividualUploadSizeMetadata
. phoneAuthRecipientMayProvidePhoneNumber (string)
. phoneAuthRecipientMayProvidePhoneNumberMetadata
. pkiSignDownloadedPDFDocs (string)
. pkiSignDownloadedPDFDocsMetadata
. readOnlyMode (string)
. readOnlyModeMetadata
. recipientsCanSignOffline (string)
. recipientsCanSignOfflineMetadata
. recipientSigningAutoNavigationControl (string)
. recipientSigningAutoNavigationControlMetadata
. recycleBinEnvelopeRetention (string)
. recycleBinEnvelopeRetentionMetadata
. require21CFRpt11Compliance (string)
. require21CFRpt11ComplianceMetadata
. requireDeclineReason (string)
. requireDeclineReasonMetadata
. requireExternalUserManagement (string)
. requireExternalUserManagementMetadata
. requireSignerCertificateType (string)
. requireSignerCertificateTypeMetadata
. rsaVeridAccountName (string)
. rsaVeridPassword (string)
. rsaVeridRuleset (string)
. rsaVeridUserId (string)
. selfSignedRecipientEmailDocument (string)
. selfSignedRecipientEmailDocumentMetadata
. selfSignedRecipientEmailDocumentUserOverride (string)
. selfSignedRecipientEmailDocumentUserOverrideMetadata
. senderCanSignInEachLocation (string)
. senderCanSignInEachLocationMetadata
. senderMustAuthenticateSigning (string)
. senderMustAuthenticateSigningMetadata
. sendingTagsFontColor (string)
. sendingTagsFontColorMetadata
. sendingTagsFontName (string)
. sendingTagsFontNameMetadata
. sendingTagsFontSize (string)
. sendingTagsFontSizeMetadata
. sendLockoutRecipientNotification (string)
. sendLockoutRecipientNotificationMetadata
. sendToCertifiedDeliveryEnabled (string)
. sendToCertifiedDeliveryEnabledMetadata
. sessionTimeout (string)
. sessionTimeoutMetadata
. setRecipEmailLang (string)
. setRecipEmailLangMetadata
. setRecipSignLang (string)
. setRecipSignLangMetadata
. sharedTemplateFolders (string)
. sharedTemplateFoldersMetadata
. showCompleteDialogInEmbeddedSession (string)
. showCompleteDialogInEmbeddedSessionMetadata
. showConditionalRoutingOnSend (string)
. showConditionalRoutingOnSendMetadata
. showInitialConditionalFields (string)
. showInitialConditionalFieldsMetadata
. showLocalizedWatermarks (string)
. showLocalizedWatermarksMetadata
. showMaskedFieldsWhenDownloadingDocumentAsSender (string)
. showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata
. showTutorials (string)
. showTutorialsMetadata
. signatureProviders (array)
. signatureProvidersMetadata
. signDateFormat (string)
. signDateFormatMetadata
. signDateTimeAccountLanguageOverride (string)
. signDateTimeAccountLanguageOverrideMetadata
. signDateTimeAccountTimezoneOverride (string)
. signDateTimeAccountTimezoneOverrideMetadata
. signerAttachCertificateToEnvelopePDF (string)
. signerAttachCertificateToEnvelopePDFMetadata
. signerAttachConcat (string)
. signerAttachConcatMetadata
. signerCanCreateAccount (string)
. signerCanCreateAccountMetadata
. signerCanSignOnMobile (string)
. signerCanSignOnMobileMetadata
. signerInSessionUseEnvelopeCompleteEmail (string)
. signerInSessionUseEnvelopeCompleteEmailMetadata
. signerLoginRequirements (string)
. signerLoginRequirementsMetadata
. signerMustHaveAccount (string)
. signerMustHaveAccountMetadata
. signerMustLoginToSign (string)
. signerMustLoginToSignMetadata
. signerShowSecureFieldInitialValues (string)
. signerShowSecureFieldInitialValuesMetadata
. signingSessionTimeout (string)
. signingSessionTimeoutMetadata
. signingUiVersion (string)
. signingUiVersionMetadata
. signTimeFormat (string)
. signTimeFormatMetadata
. signTimeShowAmPm (string)
. signTimeShowAmPmMetadata
. simplifiedSendingEnabled (string)
. simplifiedSendingEnabledMetadata
. singleSignOnEnabled (string)
. singleSignOnEnabledMetadata
. skipAuthCompletedEnvelopes (string)
. skipAuthCompletedEnvelopesMetadata
. socialIdRecipAuth (string)
. socialIdRecipAuthMetadata
. specifyDocumentVisibility (string)
. specifyDocumentVisibilityMetadata
. startInAdvancedCorrect (string)
. startInAdvancedCorrectMetadata
. supplementalDocumentsMustAccept (string)
. supplementalDocumentsMustAcceptMetadata
. supplementalDocumentsMustRead (string)
. supplementalDocumentsMustReadMetadata
. supplementalDocumentsMustView (string)
. supplementalDocumentsMustViewMetadata
. suppressCertificateEnforcement (string)
. suppressCertificateEnforcementMetadata
. tabAccountSettings
. timezoneOffsetAPI (string)
. timezoneOffsetAPIMetadata
. timezoneOffsetUI (string)
. timezoneOffsetUIMetadata
. universalSignatureOptIn (string)
. universalSignatureSkipPlatformSignature (string)
. universalSignatureSkipPlatformSignatureMetadata
. useAccountLevelEmail (string)
. useAccountLevelEmailMetadata
. useConsumerDisclosure (string)
. useConsumerDisclosureMetadata
. useConsumerDisclosureWithinAccount (string)
. useConsumerDisclosureWithinAccountMetadata
. useDerivedKeys (string)
. useDerivedKeysMetadata
. useDocuSignExpressSignerCertificate (string)
. useDocuSignExpressSignerCertificateMetadata
. useEnvelopeSearchMixedMode (string)
. useEnvelopeSearchMixedModeMetadata
. useMultiAppGroupsData (string)
. useMultiAppGroupsDataMetadata
. useNewBlobForPdf (string)
. useNewBlobForPdfMetadata
. useNewEnvelopeSearch (string)
. useNewEnvelopeSearchMetadata
. useNewEnvelopeSearchOnlyWhenSearchingAfterDate (string)
. useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata
. useNewEnvelopeSearchOnlyWithSearchTerm (string)
. useNewEnvelopeSearchOnlyWithSearchTermMetadata
. useSAFESignerCertificates (string)
. useSAFESignerCertificatesMetadata
. usesAPI (string)
. usesAPIMetadata
. useSignatureProviderPlatform (string)
. useSignatureProviderPlatformMetadata
. useSmartContractsV1 (string)
. validationsAllowed (string)
. validationsAllowedMetadata
. validationsBrand (string)
. validationsBrandMetadata
. validationsCadence (string)
. validationsCadenceMetadata
. validationsEnabled (string)
. validationsEnabledMetadata
. validationsReport (string)
. validationsReportMetadata
. waterMarkEnabled (string)
. waterMarkEnabledMetadata
. writeReminderToEnvelopeHistory (string)
. writeReminderToEnvelopeHistoryMetadata
. wurflMinAllowableScreenSize (string)
. wurflMinAllowableScreenSizeMetadata
} (object) required
esignature/get_v2_1_accounts_by_account_id_settings_bcc_email_archivesThis method retrieves all of the BCC email archive configurations associated with an account.accountId (string)
count (string)
start_position (string)
esignature/post_v2_1_accounts_by_account_id_settings_bcc_email_archivesThis method creates a BCC email archive configuration for an account adds a BCC email address to the account for archiving the emails that Docusign generates. The only property that you must set in the request body is the BCC email address that you want to use. Note: An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configurationaccountId (string)
data: {
. accountId (string)
. bccEmailArchiveId (string)
. created (string)
. createdBy
. email (string)
. emailNotificationId (string)
. modified (string)
. modifiedBy
. status (string)
. uri (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_settings_bcc_email_archives_by_bcc_email_archive_idThis method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.accountId (string)
bccEmailArchiveId (string)
count (string)
start_position (string)
esignature/delete_v2_1_accounts_by_account_id_settings_bcc_email_archives_by_bcc_email_archive_idThis method deletes a BCC email archive configuration from an account. When you use this method, the status of the BCC email archive configuration switches to closed and the BCC email address is no longer used to archive Docusign-generated email messages.accountId (string)
bccEmailArchiveId (string)
esignature/get_v2_1_accounts_by_account_id_settings_enote_configurationReturns the configuration information for the eNote eOriginal integration.accountId (string)
esignature/put_v2_1_accounts_by_account_id_settings_enote_configurationUpdates configuration information for the eNote eOriginal integration.accountId (string)
data: {
. apiKey (string)
. connectConfigured (string)
. eNoteConfigured (string)
. organization (string)
. password (string)
. userName (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_settings_enote_configurationDeletes configuration information for the eNote eOriginal integration.accountId (string)
esignature/get_v2_1_accounts_by_account_id_settings_envelope_purge_configurationAn envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period retentionDays. This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.accountId (string)
esignature/put_v2_1_accounts_by_account_id_settings_envelope_purge_configurationAn envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period retentionDays. This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopeshttps://support.docusign.com/s/document-item?bundleId=oeq1643226594604 and topicId=edo1578456348066.html.accountId (string)
data: {
. purgeEnvelopes (string)
. redactPII (string)
. removeTabsAndEnvelopeAttachments (string)
. retentionDays (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_settings_notification_defaultsThis method returns the default settings for the email notifications that signers and senders receive about envelopes.accountId (string)
esignature/put_v2_1_accounts_by_account_id_settings_notification_defaultsThis method changes the default settings for the email notifications that signers and senders receive about envelopes.accountId (string)
data: {
. apiEmailNotifications
. emailNotifications
} (object) required
esignature/get_v2_1_accounts_by_account_id_settings_password_rulesThis method retrieves the password rules for an account.accountId (string)
esignature/put_v2_1_accounts_by_account_id_settings_password_rulesThis method updates the password rules for an account. Note: To update the password rules for an account, you must be an account administrator.accountId (string)
data: {
. expirePassword (string)
. expirePasswordDays (string)
. expirePasswordDaysMetadata
. lockoutDurationMinutes (string)
. lockoutDurationMinutesMetadata
. lockoutDurationType (string)
. lockoutDurationTypeMetadata
. minimumPasswordAgeDays (string)
. minimumPasswordAgeDaysMetadata
. minimumPasswordLength (string)
. minimumPasswordLengthMetadata
. passwordIncludeDigit (string)
. passwordIncludeDigitOrSpecialCharacter (string)
. passwordIncludeLowerCase (string)
. passwordIncludeSpecialCharacter (string)
. passwordIncludeUpperCase (string)
. passwordStrengthType (string)
. passwordStrengthTypeMetadata
. questionsRequired (string)
. questionsRequiredMetadata
} (object) required
esignature/get_v2_1_accounts_by_account_id_settings_tabsThis method returns information about the tab types and tab functionality that is currently enabled for an account.accountId (string)
esignature/put_v2_1_accounts_by_account_id_settings_tabsThis method modifies the tab types and tab functionality that is enabled for an account.accountId (string)
data: {
. allowTabOrder (string)
. allowTabOrderMetadata
. approveDeclineTabsEnabled (string)
. approveDeclineTabsMetadata
. calculatedFieldsEnabled (string)
. calculatedFieldsMetadata
. checkboxTabsEnabled (string)
. checkBoxTabsMetadata
. dataFieldRegexEnabled (string)
. dataFieldRegexMetadata
. dataFieldSizeEnabled (string)
. dataFieldSizeMetadata
. drawTabsEnabled (string)
. drawTabsMetadata
. enableTabAgreementDetails (string)
. enableTabAgreementDetailsMetadata
. firstLastEmailTabsEnabled (string)
. firstLastEmailTabsMetadata
. listTabsEnabled (string)
. listTabsMetadata
. noteTabsEnabled (string)
. noteTabsMetadata
. numericalTabsEnabled (string)
. numericalTabsMetadata
. prefillTabsEnabled (string)
. prefillTabsMetadata
. radioTabsEnabled (string)
. radioTabsMetadata
. savingCustomTabsEnabled (string)
. savingCustomTabsMetadata
. senderToChangeTabAssignmentsEnabled (string)
. senderToChangeTabAssignmentsMetadata
. sharedCustomTabsEnabled (string)
. sharedCustomTabsMetadata
. tabDataLabelEnabled (string)
. tabDataLabelMetadata
. tabLocationEnabled (string)
. tabLocationMetadata
. tabLockingEnabled (string)
. tabLockingMetadata
. tabScaleEnabled (string)
. tabScaleMetadata
. tabTextFormattingEnabled (string)
. tabTextFormattingMetadata
. textTabsEnabled (string)
. textTabsMetadata
. uriTabsEnabled (string)
. uriTabsMetadata
} (object) required
esignature/get_v2_1_accounts_by_account_id_shared_accessRetrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the shared parameter to shared_from. Note: TaccountId (string)
count (string)
envelopes_not_shared_user_status (string)
folder_ids (string)
item_type (string)
search_text (string)
shared (string)
start_position (string)
user_ids (string)
esignature/put_v2_1_accounts_by_account_id_shared_accessThis sets the shared access status for one or more users or templates. When setting user shared access, only users with account administration privileges can set shared access status for envelopes. When setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates. Changes to the shared items status are not additive. The change always replaces the current status. To change template shareaccountId (string)
item_type (string)
preserve_existing_shared_access (string)
user_ids (string)
data: {
. accountId (string)
. endPosition (string)
. errorDetails
. nextUri (string)
. previousUri (string)
. resultSetSize (string)
. sharedAccess (array)
. startPosition (string)
. totalSetSize (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_signature_providersReturns a list of signature providers that the specified account can use.accountId (string)
esignature/get_v2_1_accounts_by_account_id_signaturesReturns a list of stamps available in the account.accountId (string)
stamp_format (string)
stamp_name (string)
stamp_type (string)
esignature/put_v2_1_accounts_by_account_id_signaturesAdds or updates one or more account stamps. This request may include images in multi-part format.accountId (string)
data: {
. accountSignatures (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_signaturesAdds or updates one or more account stamps.accountId (string)
decode_only (string)
data: {
. accountSignatures (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_signatures_by_signature_idReturns information about the specified stamp.accountId (string)
signatureId (string)
esignature/put_v2_1_accounts_by_account_id_signatures_by_signature_idUpdates an account stamp specified by the signatureId query parameter.accountId (string)
signatureId (string)
close_existing_signature (string)
data: {
. dateStampProperties
. disallowUserResizeStamp (string)
. externalID (string)
. imageType (string)
. isDefault (string)
. nrdsId (string)
. nrdsLastName (string)
. phoneticName (string)
. signatureFont (string)
. signatureGroups (array)
. signatureId (string)
. signatureInitials (string)
. signatureName (string)
. signatureType (string)
. signatureUsers (array)
. stampFormat (string)
. stampSizeMM (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_signatures_by_signature_idDeletes a stamp specified by signatureId.accountId (string)
signatureId (string)
esignature/get_v2_1_accounts_by_account_id_signatures_by_signature_id_by_image_typeReturns the image for an account stamp.accountId (string)
imageType (string)
signatureId (string)
include_chrome (string)
esignature/put_v2_1_accounts_by_account_id_signatures_by_signature_id_by_image_typeSets a signature image, initials, or stamp.accountId (string)
imageType (string)
signatureId (string)
transparent_png (string)
esignature/delete_v2_1_accounts_by_account_id_signatures_by_signature_id_by_image_typeDeletes the image for a stamp specified by signatureId.accountId (string)
imageType (string)
signatureId (string)
esignature/get_v2_1_accounts_by_account_id_signing_groupsRetrieves a list of all signing groups in the specified account.accountId (string)
group_type (string)
include_users (string)
esignature/put_v2_1_accounts_by_account_id_signing_groupsUpdates the name of one or more existing signing groups.accountId (string)
data: {
. groups (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_signing_groupsCreates one or more signing groups. Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members. Signing groups can be used by any account user.accountId (string)
data: {
. groups (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_signing_groupsDeletes one or more signing groups in the specified account.accountId (string)
data: {
. groups (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_signing_groups_by_signing_group_idRetrieves information, including group member information, for the specified signing group.accountId (string)
signingGroupId (string)
esignature/put_v2_1_accounts_by_account_id_signing_groups_by_signing_group_idUpdates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.accountId (string)
signingGroupId (string)
data: {
. created (string)
. createdBy (string)
. errorDetails
. groupEmail (string)
. groupName (string)
. groupType (string)
. modified (string)
. modifiedBy (string)
. signingGroupId (string)
. users (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_signing_groups_by_signing_group_id_usersRetrieves the list of members in the specified Signing Group.accountId (string)
signingGroupId (string)
esignature/put_v2_1_accounts_by_account_id_signing_groups_by_signing_group_id_usersAdds one or more new members to a signing group. A signing group can have a maximum of 50 members.accountId (string)
signingGroupId (string)
data: {
. users (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_signing_groups_by_signing_group_id_usersDeletes one or more members from the specified signing group.accountId (string)
signingGroupId (string)
data: {
. users (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_supported_languagesRetrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email naccountId (string)
esignature/get_v2_1_accounts_by_account_id_tab_definitionsRetrieves a list of all tabs associated with the account.accountId (string)
custom_tab_only (string)
esignature/post_v2_1_accounts_by_account_id_tab_definitionsCreates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the Docusign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.accountId (string)
data: {
. anchor (string)
. anchorCaseSensitive (string)
. anchorHorizontalAlignment (string)
. anchorIgnoreIfNotPresent (string)
. anchorMatchWholeWord (string)
. anchorUnits (string)
. anchorXOffset (string)
. anchorYOffset (string)
. bold (string)
. collaborative (string)
. concealValueOnDocument (string)
. createdByDisplayName (string)
. createdByUserId (string)
. customTabId (string)
. disableAutoSize (string)
. editable (string)
. font (string)
. fontColor (string)
. fontSize (string)
. height (string)
. includedInEmail (string)
. initialValue (string)
. italic (string)
. items (array)
. lastModified (string)
. lastModifiedByDisplayName (string)
. lastModifiedByUserId (string)
. localePolicy
. locked (string)
. maximumLength (string)
. maxNumericalValue (string)
. mergeField
. minNumericalValue (string)
. name (string)
. numericalValue (string)
. paymentItemCode (string)
. paymentItemDescription (string)
. paymentItemName (string)
. requireAll (string)
. required (string)
. requireInitialOnSharedChange (string)
. scaleValue (string)
. selected (string)
. shared (string)
. signatureProviderId (string)
. stampType (string)
. stampTypeMetadata
. tabLabel (string)
. type (string)
. underline (string)
. validationMessage (string)
. validationPattern (string)
. validationType (string)
. width (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_tab_definitions_by_custom_tab_idRetrieves information about the requested custom tab on the specified account.accountId (string)
customTabId (string)
esignature/put_v2_1_accounts_by_account_id_tab_definitions_by_custom_tab_idUpdates the information in a custom tab for the specified account.accountId (string)
customTabId (string)
data: {
. anchor (string)
. anchorCaseSensitive (string)
. anchorHorizontalAlignment (string)
. anchorIgnoreIfNotPresent (string)
. anchorMatchWholeWord (string)
. anchorUnits (string)
. anchorXOffset (string)
. anchorYOffset (string)
. bold (string)
. collaborative (string)
. concealValueOnDocument (string)
. createdByDisplayName (string)
. createdByUserId (string)
. customTabId (string)
. disableAutoSize (string)
. editable (string)
. font (string)
. fontColor (string)
. fontSize (string)
. height (string)
. includedInEmail (string)
. initialValue (string)
. italic (string)
. items (array)
. lastModified (string)
. lastModifiedByDisplayName (string)
. lastModifiedByUserId (string)
. localePolicy
. locked (string)
. maximumLength (string)
. maxNumericalValue (string)
. mergeField
. minNumericalValue (string)
. name (string)
. numericalValue (string)
. paymentItemCode (string)
. paymentItemDescription (string)
. paymentItemName (string)
. requireAll (string)
. required (string)
. requireInitialOnSharedChange (string)
. scaleValue (string)
. selected (string)
. shared (string)
. signatureProviderId (string)
. stampType (string)
. stampTypeMetadata
. tabLabel (string)
. type (string)
. underline (string)
. validationMessage (string)
. validationPattern (string)
. validationType (string)
. width (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_tab_definitions_by_custom_tab_idDeletes the custom from the specified account.accountId (string)
customTabId (string)
esignature/get_v2_1_accounts_by_account_id_templatesRetrieves the list of templates for the specified account. The request can be limited to a specific folder. Related topics - How to create a template/docs/esign-rest-api/how-to/create-template/accountId (string)
count (string)
created_from_date (string)
created_to_date (string)
folder_ids (string)
folder_types (string)
from_date (string)
include (string)
is_deleted_template_only (string)
is_download (string)
modified_from_date (string)
modified_to_date (string)
order (string)
order_by (string)
search_fields (string)
search_text (string)
shared_by_me (string)
start_position (string)
template_ids (string)
to_date (string)
used_from_date (string)
used_to_date (string)
user_filter (string)
user_id (string)
esignature/put_v2_1_accounts_by_account_id_templatesNo description availableaccountId (string)
data: {
. templates (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templatesCreates one or more template definitions, using a multipart request for each template. Templates/docs/esign-rest-api/esign101/concepts/templates/ help streamline the sending process when you frequently send the same or similar documents, or send different documents to the same group of people. When you create a template, you define placeholder roles. Rather than specifying a person, you specify a role that regularly participates in a transaction that uses the template. Then, when you create oraccountId (string)
data: {
. accessControlListBase64 (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoMatch (string)
. autoMatchSpecifiedByUser (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. copyRecipientData (string)
. created (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. description (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documents (array)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. favoritedByMe (string)
. folderId (string)
. folderIds (array)
. folderName (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isAceGenTemplate (string)
. isDocGenTemplate (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModified (string)
. lastModifiedBy
. lastModifiedDateTime (string)
. lastUsed (string)
. location (string)
. lockInformation
. messageLock (string)
. name (string)
. newPassword (string)
. notification
. notificationUri (string)
. owner
. pageCount (string)
. password (string)
. passwordProtected (string)
. powerForm
. powerForms (array)
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. sender
. sentDateTime (string)
. shared (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templateId (string)
. templatesUri (string)
. transactionId (string)
. uri (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_idRetrieves the definition of the specified template.accountId (string)
templateId (string)
include (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_idUpdates an existing template.accountId (string)
templateId (string)
data: {
. accessControlListBase64 (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoMatch (string)
. autoMatchSpecifiedByUser (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. copyRecipientData (string)
. created (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. description (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documents (array)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. favoritedByMe (string)
. folderId (string)
. folderIds (array)
. folderName (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isAceGenTemplate (string)
. isDocGenTemplate (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModified (string)
. lastModifiedBy
. lastModifiedDateTime (string)
. lastUsed (string)
. location (string)
. lockInformation
. messageLock (string)
. name (string)
. newPassword (string)
. notification
. notificationUri (string)
. owner
. pageCount (string)
. password (string)
. passwordProtected (string)
. powerForm
. powerForms (array)
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. sender
. sentDateTime (string)
. shared (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templateId (string)
. templatesUri (string)
. transactionId (string)
. uri (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_by_template_partShares a template with the specified members group. Note: For a newer version of this functionality, see Accounts: Update Shared Access/docs/esign-rest-api/reference/accounts/accounts/updatesharedaccess/.accountId (string)
templateId (string)
templatePart (string)
data: {
. endPosition (string)
. groups (array)
. nextUri (string)
. previousUri (string)
. resultSetSize (string)
. startPosition (string)
. totalSetSize (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_by_template_partRemoves a member group's sharing permissions for a specified template.accountId (string)
templateId (string)
templatePart (string)
data: {
. endPosition (string)
. groups (array)
. nextUri (string)
. previousUri (string)
. resultSetSize (string)
. startPosition (string)
. totalSetSize (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_custom_fieldsRetrieves the custom document field information from an existing template.accountId (string)
templateId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_custom_fieldsUpdates the custom fields in a template. Each custom field used in a template must have a unique name.accountId (string)
templateId (string)
data: {
. listCustomFields (array)
. textCustomFields (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_custom_fieldsCreates custom document fields in an existing template document.accountId (string)
templateId (string)
data: {
. listCustomFields (array)
. textCustomFields (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_custom_fieldsDeletes envelope custom fields in a template.accountId (string)
templateId (string)
data: {
. listCustomFields (array)
. textCustomFields (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_documentsRetrieves a list of documents associated with the specified template.accountId (string)
templateId (string)
include_agreement_type (string)
include_tabs (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_documentsAdds one or more documents to an existing template document.accountId (string)
templateId (string)
data: {
. accessControlListBase64 (string)
. accessibility (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowRecipientRecursion (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachments (array)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. compositeTemplates (array)
. copyRecipientData (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documents (array)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. eventNotification
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModifiedDateTime (string)
. location (string)
. lockInformation
. messageLock (string)
. notification
. notificationUri (string)
. password (string)
. powerForm
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. recipientViewRequest
. sender
. sentDateTime (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templateId (string)
. templateRoles (array)
. templatesUri (string)
. transactionId (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_documentsThis method deletes one or more documents from an existing template. To delete a document, use only the relevant parts of the envelopeDefinition envelopeDefinition. For example, this request body specifies that you want to delete the document whose documentId is '1'. text 'documents': 'documentId': '1'accountId (string)
templateId (string)
data: {
. accessControlListBase64 (string)
. accessibility (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowRecipientRecursion (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachments (array)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. compositeTemplates (array)
. copyRecipientData (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documents (array)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. eventNotification
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModifiedDateTime (string)
. location (string)
. lockInformation
. messageLock (string)
. notification
. notificationUri (string)
. password (string)
. powerForm
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. recipientViewRequest
. sender
. sentDateTime (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templateId (string)
. templateRoles (array)
. templatesUri (string)
. transactionId (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_idThis method retrieves one or more PDF documents from the template that you specify. You can specify the ID of the document to retrieve, or pass in the value combined to retrieve all documents in the template as a single PDF file.accountId (string)
documentId (string)
templateId (string)
encrypt (string)
file_type (string)
show_changes (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_idThis methods updates an existing template document.accountId (string)
documentId (string)
templateId (string)
is_envelope_definition (string)
data: {
. accessControlListBase64 (string)
. accessibility (string)
. allowComments (string)
. allowMarkup (string)
. allowReassign (string)
. allowRecipientRecursion (string)
. allowViewHistory (string)
. anySigner (string)
. asynchronous (string)
. attachments (array)
. attachmentsUri (string)
. authoritativeCopy (string)
. authoritativeCopyDefault (string)
. autoNavigation (string)
. brandId (string)
. brandLock (string)
. burnDefaultTabData (string)
. certificateUri (string)
. completedDateTime (string)
. compositeTemplates (array)
. copyRecipientData (string)
. createdDateTime (string)
. customFields
. customFieldsUri (string)
. declinedDateTime (string)
. deletedDateTime (string)
. deliveredDateTime (string)
. disableResponsiveDocument (string)
. documentBase64 (string)
. documents (array)
. documentsCombinedUri (string)
. documentsUri (string)
. emailBlurb (string)
. emailSettings
. emailSubject (string)
. enableWetSign (string)
. enforceSignerVisibility (string)
. envelopeAttachments (array)
. envelopeCustomMetadata
. envelopeDocuments (array)
. envelopeId (string)
. envelopeIdStamping (string)
. envelopeLocation (string)
. envelopeMetadata
. envelopeUri (string)
. eventNotification
. expireAfter (string)
. expireDateTime (string)
. expireEnabled (string)
. externalEnvelopeId (string)
. folders (array)
. hasComments (string)
. hasFormDataChanged (string)
. hasWavFile (string)
. holder (string)
. initialSentDateTime (string)
. is21CFRPart11 (string)
. isDynamicEnvelope (string)
. isSignatureProviderEnvelope (string)
. isTicketRelatedEnvelope (string)
. lastModifiedDateTime (string)
. location (string)
. lockInformation
. messageLock (string)
. notification
. notificationUri (string)
. password (string)
. powerForm
. purgeCompletedDate (string)
. purgeRequestDate (string)
. purgeState (string)
. recipients
. recipientsLock (string)
. recipientsUri (string)
. recipientViewRequest
. sender
. sentDateTime (string)
. signerCanSignOnMobile (string)
. signingLocation (string)
. status (string)
. statusChangedDateTime (string)
. statusDateTime (string)
. templateId (string)
. templateRoles (array)
. templatesUri (string)
. transactionId (string)
. useDisclosure (string)
. uSigState (string)
. voidedDateTime (string)
. voidedReason (string)
. workflow
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_fieldsThis method retrieves the custom document fields for an existing template document.accountId (string)
documentId (string)
templateId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_fieldsUpdates existing custom document fields in an existing template document.accountId (string)
documentId (string)
templateId (string)
data: {
. documentFields (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_fieldsCreates custom document fields in an existing template document.accountId (string)
documentId (string)
templateId (string)
data: {
. documentFields (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_fieldsDeletes custom document fields from an existing template document.accountId (string)
documentId (string)
templateId (string)
data: {
. documentFields (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_html_definitionsGets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.accountId (string)
documentId (string)
templateId (string)
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_pagesReturns images of the pages in a template document for display based on the parameters that you specify.accountId (string)
documentId (string)
templateId (string)
count (string)
dpi (string)
max_height (string)
max_width (string)
nocache (string)
show_changes (string)
start_position (string)
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_pages_by_page_numberDeletes a page from a document in a template based on the page number.accountId (string)
documentId (string)
pageNumber (string)
templateId (string)
data: {
. password (string)
. rotate (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_pages_by_page_number_page_imageRetrieves a page image for display from the specified template.accountId (string)
documentId (string)
pageNumber (string)
templateId (string)
dpi (string)
max_height (string)
max_width (string)
show_changes (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_pages_by_page_number_page_imageRotates page image from a template for display. The page image can be rotated to the left or right.accountId (string)
documentId (string)
pageNumber (string)
templateId (string)
data: {
. password (string)
. rotate (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_pages_by_page_number_tabsReturns the tabs from the page specified by pageNumber of the document specified by documentId in the template specified by templateId.accountId (string)
documentId (string)
pageNumber (string)
templateId (string)
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_responsive_html_previewCreates a preview of the responsive/docs/esign-rest-api/esign101/concepts/responsive/, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.accountId (string)
documentId (string)
templateId (string)
data: {
. displayAnchorPrefix (string)
. displayAnchors (array)
. displayOrder (string)
. displayPageNumber (string)
. documentGuid (string)
. documentId (string)
. headerLabel (string)
. maxScreenWidth (string)
. removeEmptyTags (string)
. showMobileOptimizedToggle (string)
. source (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_tabsReturns the tabs on the document specified by documentId in the template specified by templateId.accountId (string)
documentId (string)
templateId (string)
page_numbers (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_tabsUpdates tabs in the document specified by documentId in the template specified by templateId.accountId (string)
documentId (string)
templateId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_tabsAdds tabs to the document specified by documentId in the template specified by templateId. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/ definition__templatetabs_prefilltabs, your request body might look like this: 'prefillTabs': 'textTabs': 'value': 'a prefill text tab', 'pageNumber': '1', 'documentId': '1',accountId (string)
documentId (string)
templateId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_documents_by_document_id_tabsDeletes tabs from the document specified by documentId in the template specified by templateId.accountId (string)
documentId (string)
templateId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_html_definitionsGets the Original HTML Definition used to generate the Responsive HTML for the template.accountId (string)
templateId (string)
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_lockRetrieves general information about a template lock. The user requesting the information must be the same user who locked the template. You can use this method to recover the lock information, including the lockToken, for a locked template. The X-DocuSign-Edit header is included in the response. See TemplateLocks: create/docs/esign-rest-api/reference/templates/templatelocks/create/ for a description of the X-DocuSign-Edit header. Related topics - Common API Tasks: Locking and unlockingaccountId (string)
templateId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_lockUpdates the lock information for a locked template. You must include the X-DocuSign-Edit header as described in TemplateLocks: create/docs/esign-rest-api/reference/templates/templatelocks/create/. Use this method to change the duration of the lock lockDurationInSeconds or the lockedByApp string. The request body is a full lockRequest object, but you only need to specify the properties that you are updating. For example: 'lockDurationInSeconds': '3600', 'lockedByApp': 'My Application'accountId (string)
templateId (string)
data: {
. lockDurationInSeconds (string)
. lockedByApp (string)
. lockType (string)
. templatePassword (string)
. useScratchPad (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_lockThis method locks the specified template and sets the time until the lock expires to prevent other users or recipients from changing the template. The response to this request includes a lockToken parameter that you must use in the X-DocuSign-Edit header for every PUT method typically a method that updates a template while the template is locked. If you do not provide the lockToken when accessing a locked template, you will get the following error: 'errorCode': 'EDIT_LOCK_NOT_LOCK_OWNERaccountId (string)
templateId (string)
data: {
. lockDurationInSeconds (string)
. lockedByApp (string)
. lockType (string)
. templatePassword (string)
. useScratchPad (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_lockDeletes the lock from the specified template. The user deleting the lock must be the same user who locked the template. You must include the X-DocuSign-Edit header as described in TemplateLocks: create/docs/esign-rest-api/reference/templates/templatelocks/create/. This method takes an optional query parameter that lets you specify whether changes made while the template was locked are kept or discarded. | Query Parameter | DescriptionaccountId (string)
templateId (string)
data: {
. lockDurationInSeconds (string)
. lockedByApp (string)
. lockType (string)
. templatePassword (string)
. useScratchPad (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_notificationRetrieves the envelope notification, reminders and expirations, information for an existing template.accountId (string)
templateId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_notificationUpdates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.accountId (string)
templateId (string)
data: {
. expirations
. password (string)
. reminders
. useAccountDefaults (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_recipientsRetrieves the information for all recipients in the specified template.accountId (string)
templateId (string)
include_anchor_tab_locations (string)
include_extended (string)
include_tabs (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_recipientsUpdates recipients in a template. You can edit the following properties: email, userName, routingOrder, faxNumber, deliveryMethod, accessCode, and requireIdLookup.accountId (string)
templateId (string)
resend_envelope (string)
data: {
. agents (array)
. carbonCopies (array)
. certifiedDeliveries (array)
. currentRoutingOrder (string)
. editors (array)
. errorDetails
. inPersonSigners (array)
. intermediaries (array)
. notaries (array)
. notaryWitnesses (array)
. participants (array)
. recipientCount (string)
. seals (array)
. signers (array)
. witnesses (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_recipientsAdds one or more recipients to a template.accountId (string)
templateId (string)
resend_envelope (string)
data: {
. agents (array)
. carbonCopies (array)
. certifiedDeliveries (array)
. currentRoutingOrder (string)
. editors (array)
. errorDetails
. inPersonSigners (array)
. intermediaries (array)
. notaries (array)
. notaryWitnesses (array)
. participants (array)
. recipientCount (string)
. seals (array)
. signers (array)
. witnesses (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_recipientsDeletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients.accountId (string)
templateId (string)
data: {
. agents (array)
. carbonCopies (array)
. certifiedDeliveries (array)
. currentRoutingOrder (string)
. editors (array)
. errorDetails
. inPersonSigners (array)
. intermediaries (array)
. notaries (array)
. notaryWitnesses (array)
. participants (array)
. recipientCount (string)
. seals (array)
. signers (array)
. witnesses (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_recipients_by_recipient_idDeletes the specified recipient file from the specified template.accountId (string)
recipientId (string)
templateId (string)
data: {
. agents (array)
. carbonCopies (array)
. certifiedDeliveries (array)
. currentRoutingOrder (string)
. editors (array)
. errorDetails
. inPersonSigners (array)
. intermediaries (array)
. notaries (array)
. notaryWitnesses (array)
. participants (array)
. recipientCount (string)
. seals (array)
. signers (array)
. witnesses (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_recipients_by_recipient_id_document_visibilityThis method returns information about document visibility for a template recipient.accountId (string)
recipientId (string)
templateId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_recipients_by_recipient_id_document_visibilityThis method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery Needs to Sign, Editor, and Agent recipients can always see all documents.accountId (string)
recipientId (string)
templateId (string)
data: {
. documentVisibility (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_recipients_by_recipient_id_tabsGets the tabs information for a signer or sign-in-person recipient in a template.accountId (string)
recipientId (string)
templateId (string)
include_anchor_tab_locations (string)
include_metadata (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_recipients_by_recipient_id_tabsUpdates one or more tabs for a recipient in a template.accountId (string)
recipientId (string)
templateId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_recipients_by_recipient_id_tabsAdds one or more tabs for a recipient.accountId (string)
recipientId (string)
templateId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_recipients_by_recipient_id_tabsDeletes one or more tabs associated with a recipient in a template.accountId (string)
recipientId (string)
templateId (string)
data: {
. approveTabs (array)
. checkboxTabs (array)
. commentThreadTabs (array)
. commissionCountyTabs (array)
. commissionExpirationTabs (array)
. commissionNumberTabs (array)
. commissionStateTabs (array)
. companyTabs (array)
. dateSignedTabs (array)
. dateTabs (array)
. declineTabs (array)
. drawTabs (array)
. emailAddressTabs (array)
. emailTabs (array)
. envelopeIdTabs (array)
. firstNameTabs (array)
. formulaTabs (array)
. fullNameTabs (array)
. initialHereTabs (array)
. lastNameTabs (array)
. listTabs (array)
. notarizeTabs (array)
. notarySealTabs (array)
. noteTabs (array)
. numberTabs (array)
. numericalTabs (array)
. phoneNumberTabs (array)
. polyLineOverlayTabs (array)
. prefillTabs
. radioGroupTabs (array)
. signerAttachmentTabs (array)
. signHereTabs (array)
. smartSectionTabs (array)
. ssnTabs (array)
. tabGroups (array)
. textTabs (array)
. titleTabs (array)
. viewTabs (array)
. zipTabs (array)
} (object) required
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_recipients_document_visibilityThis method updates document visibility for one or more template recipients based on the recipientId and visible values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery Needs to Sign, Editor, and Agent recipients can always see all documents.accountId (string)
templateId (string)
data: {
. documentVisibility (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_responsive_html_previewCreates a preview of the responsive/docs/esign-rest-api/esign101/concepts/responsive/, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.accountId (string)
templateId (string)
data: {
. displayAnchorPrefix (string)
. displayAnchors (array)
. displayOrder (string)
. displayPageNumber (string)
. documentGuid (string)
. documentId (string)
. headerLabel (string)
. maxScreenWidth (string)
. removeEmptyTags (string)
. showMobileOptimizedToggle (string)
. source (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_views_editReturns a URL that enables you to embed the Template Edit view of Docusign eSignature. You can embed the view in an iframe. API request update The API request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version: it solves a security issue with the old version. The deprecation schedule was announced in the Docusign Core Release Noteshttps://support.docusign.com/s/document-item?language=en_US andaccountId (string)
templateId (string)
data: {
. returnUrl (string)
. settings
. viewAccess (string)
} (object) required
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_views_recipient_previewThis method returns a URL for a template recipient preview in the Docusign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Sendhttps://support.docusign.com/s/document-item?bundleId=ulp1643236876813 and topicId=oeg1578456408976.html.accountId (string)
templateId (string)
data: {
. assertionId (string)
. authenticationInstant (string)
. authenticationMethod (string)
. clientURLs
. pingFrequency (string)
. pingUrl (string)
. recipientId (string)
. returnUrl (string)
. securityDomain (string)
. xFrameOptions (string)
. xFrameOptionsAllowFromUrl (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_workflowReturns the workflow definition for the template specified by templateId. If the template does not have a workflow object, this method returns a 404.accountId (string)
templateId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_workflowUpdates the specified template's workflow definition.accountId (string)
templateId (string)
data: {
. currentWorkflowStepId (string)
. resumeDate (string)
. scheduledSending
. workflowStatus (string)
. workflowSteps (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_workflowDeletes the specified template's workflow definition if it has one. Note: If the specified template does not have a workflow definition, this endpoint returns a 200 response.accountId (string)
templateId (string)
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_workflow_scheduled_sendingGiven a template specified by templateId, returns the scheduled sending rules for that template's workflow object. Note: If the template's workflow does not have a scheduled sending object, this method returns a 404.accountId (string)
templateId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_workflow_scheduled_sendingUpdates the scheduled sending rules for a template's workflow definition.accountId (string)
templateId (string)
data: {
. bulkListId (string)
. resumeDate (string)
. rules (array)
. status (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_workflow_scheduled_sendingDeletes the scheduled sending rules for the template's workflow.accountId (string)
templateId (string)
esignature/post_v2_1_accounts_by_account_id_templates_by_template_id_workflow_stepsAdds a new step to a template's workflow.accountId (string)
templateId (string)
data: {
. action (string)
. completedDate (string)
. delayedRouting
. itemId (string)
. recipientRouting
. status (string)
. triggeredDate (string)
. triggerOnItem (string)
. workflowStepId (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_workflow_steps_by_workflow_step_idReturns a workflow step specified by workflowStepId for a template specified by templateId.accountId (string)
templateId (string)
workflowStepId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_workflow_steps_by_workflow_step_idUpdates a specified workflow step for a template.accountId (string)
templateId (string)
workflowStepId (string)
data: {
. action (string)
. completedDate (string)
. delayedRouting
. itemId (string)
. recipientRouting
. status (string)
. triggeredDate (string)
. triggerOnItem (string)
. workflowStepId (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_workflow_steps_by_workflow_step_idDeletes a workflow step from an template's workflow definition.accountId (string)
templateId (string)
workflowStepId (string)
esignature/get_v2_1_accounts_by_account_id_templates_by_template_id_workflow_steps_by_workflow_step_id_delayed_routingGiven a template and a workflow step, returns the delayed routing rules for that workflow step. Note: If the workflow step does not have a delayed routing object, this method returns a 404.accountId (string)
templateId (string)
workflowStepId (string)
esignature/put_v2_1_accounts_by_account_id_templates_by_template_id_workflow_steps_by_workflow_step_id_delayed_routingUpdates the scheduled sending rules for a template's workflow.accountId (string)
templateId (string)
workflowStepId (string)
data: {
. resumeDate (string)
. rules (array)
. status (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_templates_by_template_id_workflow_steps_by_workflow_step_id_delayed_routingDeletes the delayed routing rules for the specified template workflow step.accountId (string)
templateId (string)
workflowStepId (string)
esignature/put_v2_1_accounts_by_account_id_templates_auto_matchNo description availableaccountId (string)
data: {
. templates (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_unsupported_file_typesRetrieves a list of file types mime-types and file-extensions that are not supported for upload through the Docusign system.accountId (string)
esignature/get_v2_1_accounts_by_account_id_usersRetrieves the list of users for the specified account. The response returns the list of users for the account, with information about the result set. If the additional_info query is added to the endpoint and set to true, full user information is returned for each user.accountId (string)
additional_info (string)
alternate_admins_only (string)
count (string)
domain_users_only (string)
email (string)
email_substring (string)
group_id (string)
include_license (string)
include_usersettings_for_csv (string)
login_status (string)
not_group_id (string)
start_position (string)
status (string)
user_name_substring (string)
esignature/put_v2_1_accounts_by_account_id_usersThis method updates the information about one or more account users.accountId (string)
allow_all_languages (string)
data: {
. endPosition (string)
. nextUri (string)
. previousUri (string)
. resultSetSize (string)
. startPosition (string)
. totalSetSize (string)
. users (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_usersAdds new users to an account. The body of this request is an array of newUsers objects. For each new user, you must provide at least the userName and email properties. The maximum number of users you can create in one request is 500 users. The userSettings property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the locale is set to fr. POST /restapi/v2.1/accounts/accountId/users CoaccountId (string)
data: {
. newUsers (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_usersCloses one or more users in the account, preventing them from accessing account features. Users are not permanently deleted. The request body requires only the IDs of the users to close: json 'users': 'userId': '6b67a1ee-xxxx-xxxx-xxxx-385763624163' , 'userId': 'b6c74c52-xxxx-xxxx-xxxx-457a81d88926' , 'userId': '464f7988-xxxx-xxxx-xxxx-781ee556ab7a' You can use Users:update/docs/esign-rest-api/reference/users/users/update/ to re-open a closed user.accountId (string)
delete (string)
data: {
. users (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_users_by_user_idRetrieves the user information for the specified user. For example: json 'userName': 'Tania Morales', 'userId': '6b67a1ee-xxxx-xxxx-xxxx-385763624163', 'userType': 'CompanyUser', 'isAdmin': 'False', 'isNAREnabled': 'false', 'userStatus': 'Active', 'uri': '/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163', 'email': 'examplename42@orobia.net', 'createdDateTime': '2019-04-01T22:11:56.4570000Z', 'userAddedToAccountDateTime': '0001-01-01T08:00:00.0000000Z', 'firstName': 'Tania',accountId (string)
userId (string)
additional_info (string)
email (string)
include_license (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_idTo update user information for a specific user, submit a Users Users object with updated field values in the request body of this operation.accountId (string)
userId (string)
allow_all_languages (string)
data: {
. activationAccessCode (string)
. company (string)
. connectConfigurations (array)
. countryCode (string)
. createdDateTime (string)
. customSettings (array)
. defaultAccountId (string)
. email (string)
. enableConnectForUser (string)
. errorDetails
. firstName (string)
. forgottenPasswordInfo
. groupList (array)
. hasRemoteNotary (boolean)
. homeAddress
. initialsImageUri (string)
. isAdmin (string)
. isAlternateAdmin (string)
. isManagedByScim (string)
. isMembershipManagedByScim (string)
. isNAREnabled (string)
. jobTitle (string)
. lastLogin (string)
. lastName (string)
. licenseStatus (string)
. licenseType (string)
. loginStatus (string)
. middleName (string)
. password (string)
. passwordExpiration (string)
. permissionProfileId (string)
. permissionProfileName (string)
. profileImageUri (string)
. sendActivationEmail (string)
. sendActivationOnInvalidLogin (string)
. signatureImageUri (string)
. subscribe (string)
. suffixName (string)
. title (string)
. uri (string)
. userAddedToAccountDateTime (string)
. userId (string)
. userName (string)
. userProfileLastModifiedDate (string)
. userSettings
. userStatus (string)
. userType (string)
. workAddress
} (object) required
esignature/post_v2_1_accounts_by_account_id_users_by_user_id_authorizationCreates an authorization allowing one user to send and/or manage envelopes on behalf of another user. The agent user acts on behalf of the principal user. The principal user is specified by the userId path parameter. The agent user is specified in the request body. Each principal user can only share signing permission with one agent user. Specify in the request the level of access to share with the agent user. If you share signing access, the agent user will receive an email notification.accountId (string)
userId (string)
data: {
. agentUser
. endDate (string)
. permission (string)
. startDate (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_authorization_by_authorization_idReturns the details for the user authorization specified by the authorizationId. To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.accountId (string)
authorizationId (string)
userId (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_id_authorization_by_authorization_idUpdates the start and/or end date for a given user authorization. Specify the user authorization and principal user with the path parameters. To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.accountId (string)
authorizationId (string)
userId (string)
data: {
. endDate (string)
. startDate (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_users_by_user_id_authorization_by_authorization_idDeletes the user authorization specified by the authorizationId. To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.accountId (string)
authorizationId (string)
userId (string)
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_authorizationsReturns the user authorizations for which the user specified by userId is the principal user. To call this endpoint, you must be an account administrator or you must be the specified principal user.accountId (string)
userId (string)
active_only (string)
count (string)
email_substring (string)
include_closed_users (string)
permissions (string)
start_position (string)
user_name_substring (string)
esignature/post_v2_1_accounts_by_account_id_users_by_user_id_authorizationsCreate or update multiple user authorizations in a single request. The body of the request is a list of userAuthorizationSomething objects. To create a new authorization, specify the agentUser and permission fields, with the optional startDate and endDate fields. To update an existing authorization, specify the authorizationId field and the startDate and/or endDate fields. For example, to create a new authorization and update the end date of an existing authorization, your request body might loaccountId (string)
userId (string)
data: {
. authorizations (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_users_by_user_id_authorizationsDelete one or more user authorizations for a given principal user. The principal user is specified by the userId path parameter. To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorizations.accountId (string)
userId (string)
data: {
. authorizations (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_authorizations_agentReturns the user authorizations for which the user specified by userId is the agent user. If the calling user is an account administrator, the full results will be returned. Otherwise, only authorizations for which the calling user is the principal user will be returned.accountId (string)
userId (string)
active_only (string)
count (string)
email_substring (string)
include_closed_users (string)
permissions (string)
start_position (string)
user_name_substring (string)
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_cloud_storageRetrieves the list of cloud storage providers enabled for the account and the configuration information for the user.accountId (string)
userId (string)
redirectUrl (string)
esignature/post_v2_1_accounts_by_account_id_users_by_user_id_cloud_storageConfigures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.accountId (string)
userId (string)
data: {
. storageProviders (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_users_by_user_id_cloud_storageDeletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.accountId (string)
userId (string)
data: {
. storageProviders (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_cloud_storage_by_service_idRetrieves the list of cloud storage providers enabled for the account and the configuration information for the user.accountId (string)
serviceId (string)
userId (string)
redirectUrl (string)
esignature/delete_v2_1_accounts_by_account_id_users_by_user_id_cloud_storage_by_service_idDeletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.accountId (string)
serviceId (string)
userId (string)
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_cloud_storage_by_service_id_foldersRetrieves a list of all the items in a specified folder from the specified cloud storage provider.accountId (string)
serviceId (string)
userId (string)
cloud_storage_folder_path (string)
count (string)
order (string)
order_by (string)
search_text (string)
start_position (string)
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_cloud_storage_by_service_id_folders_by_folder_idRetrieves a list of the user's items from the specified cloud storage provider. To limit the scope of the items returned, provide a comma-separated list of folder IDs in the request.accountId (string)
folderId (string)
serviceId (string)
userId (string)
cloud_storage_folder_path (string)
cloud_storage_folderid_plain (string)
count (string)
order (string)
order_by (string)
search_text (string)
sky_drive_skip_token (string)
start_position (string)
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_custom_settingsRetrieves a list of custom user settings for a single user. Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system. Note: Custom user settings are not the same as user account settings. If the custom user settings you want to retrieve are grouped, you must include the X-DocuSign-User-Settings-Key header in the request: X-DocuSign-User-Settings-Key:group_name Where the group_name is your designated name for the group of custoaccountId (string)
userId (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_id_custom_settingsAdds or updates custom user settings for the specified user. Note: Custom user settings are not the same as user account settings. Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system. Important: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings. You can group custom user settings when adding them. GroupinaccountId (string)
userId (string)
data: {
. customSettings (array)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_users_by_user_id_custom_settingsDeletes the specified custom user settings for a single user. If the custom user settings you want to delete are grouped, you must include the X-DocuSign-User-Settings-Key header in the request: X-DocuSign-User-Settings-Key:group_name Where the group_name is your designated name for the group of customer user settings. If the X-DocuSign-User-Settings-Key header is not included, only the custom user settings that were added without a group are deleted.accountId (string)
userId (string)
data: {
. customSettings (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_profileRetrieves the user profile information, the privacy settings and personal information address, phone number, etc. for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.accountId (string)
userId (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_id_profileUpdates the user's detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user's name by changing the information in the userDetails property. When changing a user's name, you can either change the information in the userName property OR change the information in firstName, middleName, lastName, suffixName, and title properties. Changes to firstName, middleName, lastName, suffixName, and title properties take precedence oveaccountId (string)
userId (string)
data: {
. address
. authenticationMethods (array)
. companyName (string)
. displayOrganizationInfo (string)
. displayPersonalInfo (string)
. displayProfile (string)
. displayUsageHistory (string)
. profileImageUri (string)
. title (string)
. usageHistory
. userDetails
. userProfileLastModifiedDate (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_profile_imageRetrieves the user profile picture for the specified user. The userId path parameter must match the authenticated user's user ID, and the user must be a member of the specified account. | Return value | Meaning | | :---------------- | :----------------------------------------------------------------------------- | | 200 OK | The response contains the profile image in the same format as it was uploaded. | | 404accountId (string)
userId (string)
encoding (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_id_profile_imageUpdates the user profile image by uploading an image to the user profile. The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, Docusign recommends that the image is no more than 79 pixels wide and high.accountId (string)
userId (string)
esignature/delete_v2_1_accounts_by_account_id_users_by_user_id_profile_imageDeletes the user profile image from the specified user's profile. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.accountId (string)
userId (string)
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_settingsRetrieves a list of the account settings and email notification information for the specified user. The response returns the account setting name/value information and the email notification settings for the specified user. For more information, see Users:create/docs/esign-rest-api/reference/users/users/create/.accountId (string)
userId (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_id_settingsUpdates the account settings list and email notification types for the specified user.accountId (string)
userId (string)
allow_all_languages (string)
data: {
. accountAgreementsAccessType (string)
. accountAgreementsAccessTypeMetadata
. accountManagementGranular
. adminOnly (string)
. adminOnlyMetadata
. allowAccessToAllAccountAgreements (string)
. allowAccessToAllAccountAgreementsMetadata
. allowAutoTagging (string)
. allowedDocumentTemplateLibraryAccess (string)
. allowedDocumentTemplateLibraryAccessMetadata
. allowedOrchestrationAccess (string)
. allowedOrchestrationAccessMetadata
. allowEnvelopeTransferTo (string)
. allowEnvelopeTransferToMetadata
. allowEsealRecipients (string)
. allowEsealRecipientsMetadata
. allowPowerFormsAdminToAccessAllPowerFormEnvelope (string)
. allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata
. allowRecipientLanguageSelection (string)
. allowRecipientLanguageSelectionMetadata
. allowSendOnBehalfOf (string)
. allowSendOnBehalfOfMetadata
. allowSupplementalDocuments (string)
. allowSupplementalDocumentsMetadata
. allowTransactions (string)
. allowTransactionsMetadata
. anchorTagVersionedPlacementEnabled (string)
. apiAccountWideAccess (string)
. apiAccountWideAccessMetadata
. apiCanExportAC (string)
. apiCanExportACMetadata
. bulkSend (string)
. bulkSendMetadata
. canBulkUploadAgreements (string)
. canBulkUploadAgreementsMetadata
. canChargeAccount (string)
. canChargeAccountMetadata
. canCreateTransaction (string)
. canCreateTransactionMetadata
. canDeleteDocumentsInTransaction (string)
. canDeleteDocumentsInTransactionMetadata
. canDeleteTransaction (string)
. canDeleteTransactionMetadata
. canEditSharedAddressbook (string)
. canEditSharedAddressbookMetadata
. canLockEnvelopes (string)
. canLockEnvelopesMetadata
. canManageAccount (string)
. canManageAccountMetadata
. canManageAgreementParties (string)
. canManageAgreementPartiesMetadata
. canManageDistributor (string)
. canManageDistributorMetadata
. canManageTemplates (string)
. canManageTemplatesMetadata
. canSendAPIRequests (string)
. canSendAPIRequestsMetadata
. canSendEnvelope (string)
. canSendEnvelopeMetadata
. canSendEnvelopesViaSMS (string)
. canSendEnvelopesViaSMSMetadata
. canSignEnvelope (string)
. canSignEnvelopeMetadata
. canUseScratchpad (string)
. canUseScratchpadMetadata
. canUseSmartContracts (string)
. canUseSmartContractsMetadata
. disableDocumentUpload (string)
. disableDocumentUploadMetadata
. disableOtherActions (string)
. disableOtherActionsMetadata
. enableDSPro (string)
. enableDSProMetadata
. enableKeyTermsSuggestionsByDocumentType (string)
. enableKeyTermsSuggestionsByDocumentTypeMetadata
. enableSequentialSigningAPI (string)
. enableSequentialSigningAPIMetadata
. enableSequentialSigningUI (string)
. enableSequentialSigningUIMetadata
. enableSignerAttachments (string)
. enableSignerAttachmentsMetadata
. enableSignOnPaperOverride (string)
. enableSignOnPaperOverrideMetadata
. enableTransactionPoint (string)
. enableTransactionPointMetadata
. enableVaulting (string)
. enableVaultingMetadata
. expressSendOnly (string)
. isManagedByScim (string)
. isManagedByScimMetadata
. isMembershipManagedByScim (string)
. isMembershipManagedByScimMetadata
. locale (string)
. localeMetadata
. localePolicy
. manageClickwrapsMode (string)
. manageClickwrapsModeMetadata
. modifiedBy (string)
. modifiedByMetadata
. modifiedDate (string)
. modifiedDateMetadata
. modifiedPage (string)
. modifiedPageMetadata
. newSendUI (string)
. newSendUIMetadata
. powerFormMode (string)
. powerFormModeMetadata
. recipientViewedNotification (string)
. recipientViewedNotificationMetadata
. sealIdentifiers (array)
. selfSignedRecipientEmailDocument (string)
. selfSignedRecipientEmailDocumentMetadata
. senderEmailNotifications
. signerEmailNotifications
. supplementalDocumentIncludeInDownload (string)
. supplementalDocumentsMustAccept (string)
. supplementalDocumentsMustAcceptMetadata
. supplementalDocumentsMustRead (string)
. supplementalDocumentsMustReadMetadata
. supplementalDocumentsMustView (string)
. supplementalDocumentsMustViewMetadata
. templateActiveCreation (string)
. templateActiveCreationMetadata
. templateApplyNotify (string)
. templateApplyNotifyMetadata
. templateAutoMatching (string)
. templateAutoMatchingMetadata
. templateMatchingSensitivity (string)
. templateMatchingSensitivityMetadata
. templatePageLevelMatching (string)
. templatePageLevelMatchingMetadata
. timezoneDST (string)
. timezoneDSTMetadata
. timezoneMask (string)
. timezoneMaskMetadata
. timezoneOffset (string)
. timezoneOffsetMetadata
. timezoneSendingPref (string)
. timezoneSendingPrefMetadata
. timezoneSigningPref (string)
. timezoneSigningPrefMetadata
. transactionPointSiteNameURL (string)
. transactionPointSiteNameURLMetadata
. transactionPointUserName (string)
. transactionPointUserNameMetadata
. vaultingMode (string)
. vaultingModeMetadata
. webForms (string)
. webFormsMetadata
} (object) required
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_signaturesThis method retrieves the signature definitions for the user that you specify. The userId parameter specified in the endpoint must match the authenticated user's user ID, and the user must be a member of the account. The signatureId parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID signatureId, since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that casaccountId (string)
userId (string)
stamp_type (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_id_signaturesAdds/updates a user signature.accountId (string)
userId (string)
data: {
. userSignatures (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_users_by_user_id_signaturesAdds a user signature image and/or user initials image to the specified user. The userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account. The rules and processes associated with this are: If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a Docusign font, is used. If Content-Type is set to multipart/form-data, then the request must contaccountId (string)
userId (string)
data: {
. userSignatures (array)
} (object) required
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_signatures_by_signature_idRetrieves the structure of a single signature with a known signature name. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The signatureId parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID signatureId, since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode taccountId (string)
signatureId (string)
userId (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_id_signatures_by_signature_idCreates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The signatureId parameter accepts a signature ID. DocaccountId (string)
signatureId (string)
userId (string)
close_existing_signature (string)
data: {
. dateStampProperties
. disallowUserResizeStamp (string)
. externalID (string)
. imageType (string)
. isDefault (string)
. nrdsId (string)
. nrdsLastName (string)
. phoneticName (string)
. signatureFont (string)
. signatureId (string)
. signatureInitials (string)
. signatureName (string)
. signatureType (string)
. stampFormat (string)
. stampSizeMM (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_users_by_user_id_signatures_by_signature_idRemoves the signature information for the user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The signatureId accepts a signature ID or a signature name. Docusign recommends you use signature ID signatureId, since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it inaccountId (string)
signatureId (string)
userId (string)
esignature/get_v2_1_accounts_by_account_id_users_by_user_id_signatures_by_signature_id_by_image_typeRetrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome the added line and identifier around the initial image is returned with the image. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The signatureId parameter accepts a signature ID or a signature name. Docusign recommaccountId (string)
imageType (string)
signatureId (string)
userId (string)
include_chrome (string)
esignature/put_v2_1_accounts_by_account_id_users_by_user_id_signatures_by_signature_id_by_image_typeUpdates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The signatureId parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID signatureId, since some names contain characters that do not propeaccountId (string)
imageType (string)
signatureId (string)
userId (string)
transparent_png (string)
data (string) required
esignature/delete_v2_1_accounts_by_account_id_users_by_user_id_signatures_by_signature_id_by_image_typeDeletes the specified initials image or signature image for the specified user. The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The signatureId parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID signatureId, since someaccountId (string)
imageType (string)
signatureId (string)
userId (string)
esignature/post_v2_1_accounts_by_account_id_views_consoleReturns a URL that enables you to embed the Docusign UI in your applications. To view a specific envelope, set the envelopeId property in the request body. Information security notice This method provides full access to the sending account. Related topics - How to embed the Docusign UI in your app/docs/esign-rest-api/how-to/embed-ui/accountId (string)
data: {
. envelopeId (string)
. returnUrl (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_watermarkEnables you to preview a watermark specified by the request.accountId (string)
esignature/put_v2_1_accounts_by_account_id_watermarkReturns information about the watermark for the account.accountId (string)
data: {
. displayAngle (string)
. enabled (string)
. font (string)
. fontColor (string)
. fontSize (string)
. id (string)
. imageBase64 (string)
. transparency (string)
. watermarkText (string)
} (object) required
esignature/put_v2_1_accounts_by_account_id_watermark_previewUpdate the watermark for the account. Note: Many of the request fields must be set to specific values. If you use an invalid value for one of these fields, the endpoint may return 200 OK but set the field to a default value. See the request body for more information.accountId (string)
data: {
. displayAngle (string)
. enabled (string)
. font (string)
. fontColor (string)
. fontSize (string)
. id (string)
. imageBase64 (string)
. transparency (string)
. watermarkText (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_workspacesGets information about the Workspaces that have been created.accountId (string)
esignature/post_v2_1_accounts_by_account_id_workspacesThis method creates a new workspace.accountId (string)
data: {
. billableAccountId (string)
. callerInformation
. created (string)
. createdByInformation
. lastModified (string)
. lastModifiedByInformation
. settings
. status (string)
. workspaceBaseUrl (string)
. workspaceDescription (string)
. workspaceId (string)
. workspaceName (string)
. workspaceUri (string)
} (object) required
esignature/get_v2_1_accounts_by_account_id_workspaces_by_workspace_idRetrieves properties about a workspace given a unique workspaceId.accountId (string)
workspaceId (string)
esignature/put_v2_1_accounts_by_account_id_workspaces_by_workspace_idUpdates information about a specific workspace.accountId (string)
workspaceId (string)
data: {
. billableAccountId (string)
. callerInformation
. created (string)
. createdByInformation
. lastModified (string)
. lastModifiedByInformation
. settings
. status (string)
. workspaceBaseUrl (string)
. workspaceDescription (string)
. workspaceId (string)
. workspaceName (string)
. workspaceUri (string)
} (object) required
esignature/delete_v2_1_accounts_by_account_id_workspaces_by_workspace_idDeletes an existing workspace logically.accountId (string)
workspaceId (string)
esignature/get_v2_1_accounts_by_account_id_workspaces_by_workspace_id_folders_by_folder_idThis method returns the contents of a workspace folder, which can include sub-folders and files.accountId (string)
folderId (string)
workspaceId (string)
count (string)
include_files (string)
include_sub_folders (string)
include_thumbnails (string)
include_user_detail (string)
start_position (string)
workspace_user_id (string)
esignature/delete_v2_1_accounts_by_account_id_workspaces_by_workspace_id_folders_by_folder_idThis method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the status of the workspace must be active.accountId (string)
folderId (string)
workspaceId (string)
data: {
. items (array)
} (object) required
esignature/post_v2_1_accounts_by_account_id_workspaces_by_workspace_id_folders_by_folder_id_filesThis method adds a file to a workspace.accountId (string)
folderId (string)
workspaceId (string)
esignature/get_v2_1_accounts_by_account_id_workspaces_by_workspace_id_folders_by_folder_id_files_by_file_idThis method returns a binary version of a file in a workspace.accountId (string)
fileId (string)
folderId (string)
workspaceId (string)
is_download (string)
pdf_version (string)
esignature/put_v2_1_accounts_by_account_id_workspaces_by_workspace_id_folders_by_folder_id_files_by_file_idThis method updates the metadata for one or more specific files or folders in a workspace.accountId (string)
fileId (string)
folderId (string)
workspaceId (string)
esignature/get_v2_1_accounts_by_account_id_workspaces_by_workspace_id_folders_by_folder_id_files_by_file_id_pagesThis method returns a workspace file as rasterized pages.accountId (string)
fileId (string)
folderId (string)
workspaceId (string)
count (string)
dpi (string)
max_height (string)
max_width (string)
start_position (string)
esignature/get_v2_1_accounts_provisioningRetrieves the account provisioning information for the account.No parameters
esignature/get_v2_1_billing_plansRetrieves a list of the billing plans associated with a distributor.No parameters
esignature/get_v2_1_billing_plans_by_billing_plan_idRetrieves the billing plan details for the specified billing plan ID.billingPlanId (string)
esignature/get_v2_1_current_user_notaryGets settings for a notary user. The current user must be a notary.include_jurisdictions (string)
esignature/put_v2_1_current_user_notaryUpdates notary information for the current user.data: {
. createdDate (string)
. enabled (string)
. searchable (string)
. userInfo
} (object) required
esignature/post_v2_1_current_user_notaryRegisters the current user as a notary.data: {
. createdDate (string)
. enabled (string)
. searchable (string)
. userInfo
} (object) required
esignature/get_v2_1_current_user_notary_journalsGets notary jurisdictions for a user.count (string)
search_text (string)
start_position (string)
esignature/get_v2_1_current_user_notary_jurisdictionsReturns a list of jurisdictions that the notary is registered in. The current user must be a notary.No parameters
esignature/post_v2_1_current_user_notary_jurisdictionsCreates a jurisdiction object.data: {
. commissionExpiration (string)
. commissionId (string)
. county (string)
. errorDetails
. jurisdiction
. registeredName (string)
. sealType (string)
} (object) required
esignature/get_v2_1_current_user_notary_jurisdictions_by_jurisdiction_idGets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The jurisdictionId must be a jurisdiction that the notary is registered for.jurisdictionId (string)
esignature/put_v2_1_current_user_notary_jurisdictions_by_jurisdiction_idUpdates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The jurisdictionId path parameter must be a jurisdiction that the notary is registered for. - The jurisdictionId path parameter must match the request body's jurisdiction.jurisdictionId. The request body must have a full jurisdiction object for the jurisdiction property. The best way to do this is to use getNotaryJurisdiction to obtain the current values and update thejurisdictionId (string)
data: {
. commissionExpiration (string)
. commissionId (string)
. county (string)
. errorDetails
. jurisdiction
. registeredName (string)
. sealType (string)
} (object) required
esignature/delete_v2_1_current_user_notary_jurisdictions_by_jurisdiction_idDeletes the specified jurisdiction.jurisdictionId (string)
esignature/get_v2_1_current_user_password_rulesGets membership account password rules.No parameters
esignature/get_v2_1_diagnostics_request_logsRetrieves a list of log entries as a JSON or XML object or as a zip file containing the entries. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If the Accept header is set to application/json or application/xml, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below.encoding (string)
esignature/delete_v2_1_diagnostics_request_logsDeletes the request log files.No parameters
esignature/get_v2_1_diagnostics_request_logs_by_request_log_idRetrieves information for a single log entry. Request The requestLogId property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned. Response If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.requestLogId (string)
esignature/get_v2_1_diagnostics_settingsRetrieves the current API request logging setting for the user and remaining log entries. Response The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.No parameters
esignature/put_v2_1_diagnostics_settingsEnables or disables API request logging for troubleshooting. When enabled apiRequestLogging is true, REST API requests and responses for the user are added to a log. A log can have up to 50 requests/responses and the current number of log entries can be determined by getting the settings. Logging is automatically disabled when the log limit of 50 is reached. You can call Diagnostics: getRequestLog/docs/esign-rest-api/reference/diagnostics/requestlogs/get/ or Diagnostics: listRequestLogs/docs/edata: {
. apiRequestLogging (string)
. apiRequestLogMaxEntries (string)
. apiRequestLogRemainingEntries (string)
} (object) required
admin/get_v2_organizationsReturns a list of organizations that the authenticated user belongs to. Note that the Docusign Admin API only returns JSON, not XML. Required authentication scopes/docs/admin-api/admin101/auth/: organization_read. This method requires user authentication. It will fail with an application access token/docs/admin-api/admin101/application-auth/.mode (string)
admin/post_v2_data_redaction_accounts_by_account_id_userDeletes the data for a single account membership for a specified user. To call this endpoint: You must be an administrator or delegated administrator of the specified account. The user must have been closed for at least 24 hours. Note: After a user's data is deleted for every account to which they belong, their user-level data will automatically be deleted. Required authentication scopes/docs/admin-api/admin101/auth/: user_data_redact. Related topics - How to delete user data from anaccountId (string)
data: {
. user_id (string)
} (object) required
admin/get_v2_organizations_by_organization_id_accounts_by_account_id_permissionsReturns the list of permission profiles in an account. Required authentication scopes/docs/admin-api/admin101/auth/: permission_read. Related topics - How to create a new active eSignature user/docs/admin-api/how-to/create-active-user/organizationId (string)
accountId (string)
admin/get_v2_organizations_by_organization_id_accounts_by_account_id_groupsReturns the list of groups in an account. Required authentication scopes/docs/admin-api/admin101/auth/: group_read. Related topics - How to create a new active eSignature user/docs/admin-api/how-to/create-active-user/organizationId (string)
accountId (string)
start (integer)
take (integer)
end (integer)
admin/get_v2_organizations_by_organization_id_exports_user_listReturns a list of pending and completed export requests. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
admin/post_v2_organizations_by_organization_id_exports_user_listCreate a user list export request. This method initiates a user list export request. You specify the type of export request as JSON in the body of method, like this: json 'type': 'organization_memberships_export' The export request type is one of three values: | Value | Description | | :----------------------------------------- | :-----------------------------organizationId (string)
data: {
. type (string)
. accounts (array)
. domains (array)
} (object) required
admin/get_v2_organizations_by_organization_id_exports_account_settingsReturns a list of pending and completed account settings export requests. Required authentication scopes/docs/admin-api/admin101/auth/: account_read.organizationId (string)
admin/post_v2_organizations_by_organization_id_exports_account_settingsCreates a new account settings export request. To learn more about exporting account settings, see Account Settings Exportguide-export in the Docusign Admin Guide. You can export settings for up to 40 accounts at a time. Specify the accounts whose settings you are requesting as JSON in the body of the request, like this: json 'accounts': 'account_id': '9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e', 'account_id': '624e3e00-xxxx-xxxx-xxxx-43918c520dab' Required authentication scopeorganizationId (string)
data: {
. accounts (array)
} (object) required
admin/get_v2_organizations_by_organization_id_exports_user_list_by_export_idReturns the results for single user list export request. Given an export ID, this method returns the results of a single user list export request. To get a list of all the export requests, use getUserListExports. Note that the metadata_url property of the response from createUserListExport is a read-to-use HTTP GET request to get the status. The results are available through a URL that you can access through the results property of the response. For example, to get the URL of the first resultorganizationId (string)
exportId (string)
admin/delete_v2_organizations_by_organization_id_exports_user_list_by_export_idDeletes a single user list export request. Use this method to delete pending or completed user export requests. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
exportId (string)
admin/get_v2_organizations_by_organization_id_exports_account_settings_by_export_idReturns the results for a single account settings export request. Given an export ID, this method returns the results of an account settings export request. To get a list of all the export requests, use getAccountSettingsExports. The results are available through a URL that you can access through the results property of the response. For example, to get the URL of first result you might use results0.url The settings export is formatted like this: json 'accounts': 'account_id'organizationId (string)
exportId (string)
admin/delete_v2_organizations_by_organization_id_exports_account_settings_by_export_idDeletes a single account settings export request. Any data associated with the request is also deleted. Required authentication scopes/docs/admin-api/admin101/auth/: account_read.organizationId (string)
exportId (string)
admin/get_v2_organizations_by_organization_id_imports_account_settingsReturns the details and metadata for Bulk Account Settings Import requests in the organization. Required authentication scopes/docs/admin-api/admin101/auth/: account_read.organizationId (string)
admin/post_v2_organizations_by_organization_id_imports_account_settingsCreates a new account settings import request. The request for this method consists of the contents of a CSV file. You can export your current settings as a CSV file with AccountSettingsExport: createAccountSettingsExport/docs/admin-api/reference/bulkoperations/accountsettingsexport/createaccountsettingsexport/ and use it as the basis of the changes you want to import. To learn more about the format of a settings CSV file, see Preparing a CSV for account settings importguide-import in the DoorganizationId (string)
admin/get_v2_organizations_by_organization_id_imports_account_settings_by_import_idReturns the details/metadata for a Bulk Account Settings Import request. Given an import ID, this method returns the results of an account settings import request. To get a list of all the import requests, use getAccountSettingsImports. Required authentication scopes/docs/admin-api/admin101/auth/: account_read.organizationId (string)
importId (string)
admin/delete_v2_organizations_by_organization_id_imports_account_settings_by_import_idDeletes a single account settings import request. Any data associated with the request is also deleted. Required authentication scopes/docs/admin-api/admin101/auth/: account_write.organizationId (string)
importId (string)
admin/post_v2_organizations_by_organization_id_imports_bulk_users_addCreates a request to import new users. Your CSV import file is made up of a header row with the column headers and a row of user or account data for each user you want to add to an account. Only new users can be imported. Any changes to existing users will be ignored. To make changes to existing users, use UserImport:updateBulkUserImports/docs/admin-api/reference/bulkoperations/userimport/updatebulkuserimports/. To ensure your CSV file is properly formatted, follow the requirements in the SupporganizationId (string)
admin/post_v2_organizations_by_organization_id_accounts_by_account_id_imports_bulk_users_addImport request for adding a user to a single account within the organization. This method lets you upload user information without requiring an AccountId column. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
accountId (string)
admin/post_v2_organizations_by_organization_id_imports_bulk_users_updateBulk updates information for existing users. Your CSV import file is made up of a header row with the column headers and a row of user or account data for each user you want to add to an account. Update limit: You can update up to 2,000 users on an account and include up to 50 accounts per import. The maximum number of updated users per import is 8,000. This method requires the following HTTP headers: | Header | Value | | :--- | :--- | | Content-Type | text/csv | | Content-Disposition |organizationId (string)
admin/post_v2_organizations_by_organization_id_accounts_by_account_id_imports_bulk_users_updateImport request for updating users for a single account within the organization. This method lets you upload user information without requiring an AccountId column. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
accountId (string)
admin/post_v2_organizations_by_organization_id_imports_bulk_users_closeCreates a request to close the accounts of existing users. Given a CSV list of users, close their accounts. Your CSV import file is made up of a header row with the column headers and a row of user or account data for each user whose account you want to close. To ensure your CSV is properly formatted, use the Sample Bulk Update CSV filehttps://admin.docusign.com/static-resources/organization-user-update-import.csv as a template. The following table describes the columns. | ColumnorganizationId (string)
admin/post_v2_organizations_by_organization_id_imports_bulk_users_close_externalCloses external memberships. External memberships are users who have an email address at a verified domain but do not belong to the organization. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
admin/get_v2_organizations_by_organization_id_imports_bulk_usersGets a list of all of the user import requests. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
admin/get_v2_organizations_by_organization_id_imports_bulk_users_by_import_idReturns the details of a single user import request. Use this method to check the status of the request by looking at the status property of the response. Once the status becomes completed or fails, use this method to get the details. To get a list of all of the user import requests, use getBulkUserImportRequests. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
importId (string)
admin/delete_v2_organizations_by_organization_id_imports_bulk_users_by_import_idDeletes a specific import request and its results. To delete a user, see closeBulkUserImportRequest/docs/admin-api/reference/bulkoperations/userimport/closebulkuserimportrequest/. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
importId (string)
admin/get_v2_organizations_by_organization_id_imports_bulk_users_by_import_id_results_csvReturns the contents of the CSV file associated with a user import request. The results have an additional column, ProcessingResults, that describes the results of importing that row. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
importId (string)
admin/get_v2_organizations_by_organization_id_identity_providersReturns the list of identity providers for an organization. Required authentication scopes/docs/admin-api/admin101/auth/: identity_provider_read.organizationId (string)
admin/post_v2_data_redaction_organizations_by_organization_id_userDeletes data for one or more of a user's account memberships. To call this endpoint: You must be an organization administrator or delegated administrator with permission to manage the specified accounts or the user's email domain. The user must have been closed for at least 24 hours. Note: After a user's data is deleted for every account to which they belong, their user-level data will automatically be deleted. Required authentication scopes/docs/admin-api/admin101/auth/: user_data_redact.organizationId (string)
data: {
. user_id (string)
. memberships (array)
} (object) required
admin/get_v2_organizations_by_organization_id_reserved_domainsReturns the list of reserved domains for the organization. Required authentication scopes/docs/admin-api/admin101/auth/: domain_read.organizationId (string)
admin/post_v2_organizations_by_organization_id_users_profilesUpdates a user's information. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
apply_license_override (boolean)
data: {
. users (array)
. auto_activate_memberships_on_reactivation (boolean)
} (object) required
admin/post_v2_organizations_by_organization_id_users_email_addressesUpdates a user's email address. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
data: {
. users (array)
} (object) required
admin/delete_v2_organizations_by_organization_id_users_by_user_id_accountsCloses a user's memberships. Required authentication scopes/docs/admin-api/admin101/auth/: user_write. This method requires user authentication. It will fail with an application access token/docs/admin-api/admin101/application-auth/.organizationId (string)
userId (string)
data: {
. accounts (array)
} (object) required
admin/get_v2_organizations_by_organization_id_usersReturns information about the users in an organization. You must include at least one of the following query parameters in the request: - account_id: The ID of an account associated with the organization. - organization_reserved_domain_id: The ID of one of the organization's reserved domains. - email: An email address associated with the users that you want to return. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
start (integer)
take (integer)
end (integer)
email (string)
email_user_name_like (string)
status (string)
membership_status (string)
account_id (string)
organization_reserved_domain_id (string)
last_modified_since (string)
include_ds_groups (boolean)
include_license (boolean)
admin/post_v2_organizations_by_organization_id_usersCreates a new eSignature user and automatically activates the user's account. Required authentication scopes/docs/admin-api/admin101/auth/: user_write. Related topics - How to create a new active eSignature user/docs/admin-api/how-to/create-active-user/organizationId (string)
data: {
. accounts (array)
. user_name (string)
. first_name (string)
. last_name (string)
. email (string)
. default_account_id (string)
. language_culture (string)
. selected_languages (string)
. access_code (string)
. federated_status (string)
. auto_activate_memberships (boolean)
} (object) required
admin/post_v2_organizations_by_organization_id_users_by_user_id_memberships_by_membership_idActivates user memberships. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
userId (string)
membershipId (string)
data: {
. site_id (integer)
} (object) required
admin/get_v2_organizations_by_organization_id_users_profileReturns historical information about users with a specific email address. Note: The email query parameter is required. To get a list of users in an organization, use Users: getUsers/docs/admin-api/reference/usermanagement/users/getusers/ instead. For example, the following request gets information about accounts that use max@example.net as an email address: json GET /Management/v2/organizations/96e994fa-xxxx-xxxx-xxxx-c5fe9d1ccd10/users/profile?email=max@example.net 'users':organizationId (string)
email (string)
include_license (boolean)
admin/delete_v2_organizations_by_organization_id_users_by_user_id_identitiesDeletes all user identities linked to a specified identity provider. The id request body property specifies the identity provider. To get the ID, call getUserProfiles/docs/admin-api/reference/usermanagement/esignusermanagement/getuserprofiles/ and copy the provider_id value you want to use. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
userId (string)
data: {
. identities (array)
} (object) required
admin/post_v2_organizations_by_organization_id_accounts_by_account_id_usersAdds users to an account. Required authentication scopes/docs/admin-api/admin101/auth/: user_write. Related topics - How to create a new active eSignature user/docs/admin-api/how-to/create-active-user/organizationId (string)
accountId (string)
data: {
. permission_profile
. groups (array)
. user_name (string)
. first_name (string)
. last_name (string)
. email (string)
. default_account_id (string)
. language_culture (string)
. selected_languages (string)
. access_code (string)
. federated_status (string)
. auto_activate_memberships (boolean)
. license_type (string)
} (object) required
admin/get_v2_1_organizations_by_organization_id_accounts_by_account_id_dsgroupsReturns a list of DSGroups. Required authentication scopes/docs/admin-api/admin101/auth/: user_read. Related topics - How to create a new active user for CLM and eSignature/docs/admin-api/how-to/create-active-clm-esign-user/organizationId (string)
accountId (string)
page (integer)
page_size (integer)
admin/post_v2_1_organizations_by_organization_id_accounts_by_account_id_dsgroupsCreates a new DSGroup. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
accountId (string)
data: {
. group_name (string)
. description (string)
} (object) required
admin/get_v2_1_organizations_by_organization_id_accounts_by_account_id_dsgroups_by_ds_group_idReturns details about a single DSGroup. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
accountId (string)
dsGroupId (string)
admin/delete_v2_1_organizations_by_organization_id_accounts_by_account_id_dsgroups_by_ds_group_idDeletes a DSGroup. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
accountId (string)
dsGroupId (string)
admin/get_v2_1_organizations_by_organization_id_accounts_by_account_id_dsgroups_by_ds_group_id_usersGets a list of users in a DSGroup. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
accountId (string)
dsGroupId (string)
page (integer)
page_size (integer)
admin/post_v2_1_organizations_by_organization_id_accounts_by_account_id_dsgroups_by_ds_group_id_usersAdds a list of users to a DSGroup. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
accountId (string)
dsGroupId (string)
data: {
. user_ids (array)
} (object) required
admin/delete_v2_1_organizations_by_organization_id_accounts_by_account_id_dsgroups_by_ds_group_id_usersRemoves a list of users from a DSGroup. In the request body, you can specify users by ID or email address. If both parameters are included, the email address parameter will be ignored. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
accountId (string)
dsGroupId (string)
data: {
. user_ids (array)
. user_emails (array)
} (object) required
admin/get_v2_1_organizations_by_organization_id_accounts_by_account_id_products_permission_profilesGets products associated with the account and the available permission profiles. Required authentication scopes/docs/admin-api/admin101/auth/: user_read. Related topics - How to create a new active user for CLM and eSignature/docs/admin-api/how-to/create-active-clm-esign-user/organizationId (string)
accountId (string)
admin/get_v2_1_organizations_by_organization_id_accounts_by_account_id_products_users_by_user_id_permission_profilesRetrieves a list of a user's permission profiles for each account's product. The user is specified by the ID provided in the userId path parameter. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
accountId (string)
userId (string)
admin/post_v2_1_organizations_by_organization_id_accounts_by_account_id_products_users_by_user_id_permission_profilesSets permission profiles for one or more products for a given user. The user is specified by the userId path parameter. Required authentication scopes/docs/admin-api/admin101/auth/: user_write.organizationId (string)
accountId (string)
userId (string)
data: {
. product_permission_profiles (array)
} (object) required
admin/post_v2_1_organizations_by_organization_id_accounts_by_account_id_usersCreates or updates a multi-product eSignature and CLM user. When you use this method to create a user, the user's account is automatically activated. Required authentication scopes/docs/admin-api/admin101/auth/: user_write. Next steps Explore an example that demonstrates how to construct the request body and call the endpoint/docs/admin-api/how-to/create-active-clm-esign-user/.organizationId (string)
accountId (string)
data: {
. product_permission_profiles (array)
. ds_groups (array)
. user_name (string)
. first_name (string)
. last_name (string)
. email (string)
. default_account_id (string)
. language_culture (string)
. access_code (string)
. federated_status (string)
. auto_activate_memberships (boolean)
. license_type (string)
} (object) required
admin/get_v2_1_organizations_by_organization_id_users_dsprofileGets information about a user specified by the email query parameter. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
email (string)
sort (boolean)
include_license (boolean)
admin/get_v2_1_organizations_by_organization_id_users_by_user_id_dsprofileGets information about a user specified by the userId query parameter. Required authentication scopes/docs/admin-api/admin101/auth/: user_read. Related topics - How to retrieve the user's Docusign profile using an email address/docs/admin-api/how-to/retrieve-docusign-profile-using-email/ - How to retrieve the user's Docusign profile using a User ID/docs/admin-api/how-to/retrieve-docusign-profile-using-userid/organizationId (string)
userId (string)
sort (boolean)
include_license (boolean)
admin/delete_v2_1_organizations_by_organization_id_accounts_by_account_id_products_usersRevokes a specified user's access to one or more products. Required authentication scopes/docs/admin-api/admin101/auth/: user_write. Related topics - How to delete user data from an account as an account admin/docs/admin-api/how-to/account-admin-delete-user-data/organizationId (string)
accountId (string)
data: {
. user_email (string)
. user_id (string)
. product_ids (array)
} (object) required
admin/get_v2_1_organizations_by_organization_id_accounts_by_account_id_products_permission_profiles_usersRetrieves a list of a user's permission profiles for each account's product. The user is specified by the email address provided in the email query parameter. Required authentication scopes/docs/admin-api/admin101/auth/: user_read.organizationId (string)
accountId (string)
email (string)
admin/post_v2_1_organizations_by_organization_id_accounts_by_account_id_products_permission_profiles_usersSets permission profiles for one or more products for a given user. The user is specified by the email property in the request body. Required authentication scopes/docs/admin-api/admin101/auth/: user_write. Related topics - How to update user product permission profiles using an email address/docs/admin-api/how-to/update-user-product-permission-profiles-using-email/ - How to delete user product permission profiles using an email address/docs/admin-api/how-to/delete-user-product-permissioorganizationId (string)
accountId (string)
data: {
. email (string)
. product_permission_profiles (array)
} (object) required
admin/get_v2_organizations_by_organization_id_asset_groups_accountsReturns a list of asset group accounts for an organization. An asset group is a set of modules, products, plans, and charges purchased for your organization. An asset group account is an account that has been linked to an asset group. To call this endpoint: You must be an administrator for the specified organization. Required authentication scopes/docs/admin-api/admin101/auth/: asset_group_account_read. Next steps See how to use this endpoint in your chosen programming language/docs/adorganizationId (string)
compliant (boolean)
admin/post_v2_organizations_by_organization_id_asset_groups_account_cloneClones an existing Docusign account. Cloning an account copies the plan items and eSignature settings. Users, templates, and permission profiles are not copied into the target account. The new account will linked to the same organization. In the request body, specify the source account you are cloning by its ID. You can get the IDs for your organization's asset group accounts using the getAssetGroupAccounts/docs/admin-api/reference/accountprovisioning/accountcloning/getassetgroupaccounts/ endorganizationId (string)
data: {
. sourceAccount
. targetAccount
. assetGroupWorkId (string)
. assetGroupId (string)
. assetGroupWorkType (string)
. status (string)
. cloneRequestId (string)
. orderId (string)
. attempts (integer)
. createdDate (string)
. createdByName (string)
. createdByEmail (string)
. message (string)
. cloneProcessingFailureDetails
} (object) required
admin/get_v2_organizations_by_organization_id_asset_groups_account_clonesRetrieves all the cloned accounts for an organization. To call this endpoint: You must be an administrator for the specified organization. Required scopes/docs/admin-api/admin101/auth/: asset_group_account_clone_read.organizationId (string)
since_updated_date (string)
include_details (boolean)
admin/get_v2_organizations_by_organization_id_asset_groups_by_asset_group_id_account_clones_by_asset_group_work_idGets information about a cloned account by the assetGroupWorkId. To call this endpoint: You must be an administrator for the specified organization. Required scopes/docs/admin-api/admin101/auth/: asset_group_account_clone_read.organizationId (string)
assetGroupId (string)
assetGroupWorkId (string)
include_details (boolean)
admin/get_v2_organizations_by_organization_id_plan_itemsGets the plan items and subscription information for an organization. To call this endpoint: You must be an administrator for the specified organization Required scopes/docs/admin-api/admin101/auth/: organization_sub_account_readorganizationId (string)
admin/post_v2_organizations_by_organization_id_asset_groups_account_createCreates a new Docusign account within an organization. In the request body, specify the subscription and plan IDs for the new account. You can get these IDs through the GetOrganizationPlanItems/docs/admin-api/reference/accountprovisioning/accountcreation/getorganizationplanitems/ endpoint. You also need to specify information about the new target account, including the name, location, and administrator. To set the location, provide the countryCode property. When you are testing in the developorganizationId (string)
data: {
. subscriptionDetails
. targetAccount
} (object) required
admin/get_v2_organizations_by_organization_id_sub_accounts_createdGet ongoing account creation processes by organizationId. To call this endpoint: You must be an administrator for the specified organization Required scopes/docs/admin-api/admin101/auth/: organization_sub_account_readorganizationId (string)
since_updated_date (string)
include_details (boolean)
admin/get_v2_organizations_by_organization_id_asset_group_by_asset_group_id_sub_account_created_by_asset_group_work_idGets information about an account creation process by the assetGroupId. To call this endpoint: You must be an administrator for the specified organization Required scopes/docs/admin-api/admin101/auth/: organization_sub_account_readorganizationId (string)
assetGroupId (string)
assetGroupWorkId (string)
include_details (boolean)
admin/get_v2_organizations_by_organization_id_connectNo description availableorganizationId (string)
sortBy (string)
siteId (integer)
accountId (string)
allowEnvelopePublish (boolean)
q (string)
admin/post_v2_organizations_by_organization_id_connectNo description availableorganizationId (string)
data: {
. connectId (string)
. configurationType (string)
. allowEnvelopePublish (string)
. urlToPublishTo (string)
. deliveryMode (string)
. events (array)
. associatedFilterSelection (string)
. groupIds (array)
. accountIds (array)
. userIds (array)
. name (string)
. signMessageWithX509Certificate (string)
. includeOAuth (string)
. includeHMAC (string)
. pausePublish (string)
. eventData
} (object) required
admin/get_v2_organizations_by_organization_id_connect_by_connect_idNo description availableorganizationId (string)
connectId (string)
admin/delete_v2_organizations_by_organization_id_connect_by_connect_idNo description availableorganizationId (string)
connectId (string)
admin/put_v2_organizations_by_organization_id_connect_by_connect_idNo description availableorganizationId (string)
connectId (string)
data: {
. connectId (string)
. configurationType (string)
. allowEnvelopePublish (string)
. urlToPublishTo (string)
. deliveryMode (string)
. events (array)
. associatedFilterSelection (string)
. groupIds (array)
. accountIds (array)
. userIds (array)
. name (string)
. signMessageWithX509Certificate (string)
. includeOAuth (string)
. includeHMAC (string)
. pausePublish (string)
. eventData
} (object) required
admin/delete_v2_organizations_by_organization_id_connect_oauthNo description availableorganizationId (string)
admin/get_v2_organizations_by_organization_id_connect_oauthNo description availableorganizationId (string)
admin/post_v2_organizations_by_organization_id_connect_oauthNo description availableorganizationId (string)
data: {
. authorizationServerUrl (string)
. clientId (string)
. clientSecret (string)
. scope (string)
. customParameter (object)
} (object) required
admin/put_v2_organizations_by_organization_id_connect_oauthNo description availableorganizationId (string)
data: {
. authorizationServerUrl (string)
. clientId (string)
. clientSecret (string)
. scope (string)
. customParameter (object)
} (object) required
admin/get_v2_organizations_by_organization_id_connect_secretNo description availableorganizationId (string)
admin/post_v2_organizations_by_organization_id_connect_secretNo description availableorganizationId (string)
admin/delete_v2_organizations_by_organization_id_connect_secret_by_key_idNo description availableorganizationId (string)
keyId (string)
click/get_service_informationThe response includes information about the version of the Click API. 'serviceVersions': 'version': 'v1', 'versionUrl': 'https://demo.docusign.net/clickapi/v1' , 'buildVersion': '20.4.0.16708 20.4.00.00_newt.16708+g236a94', 'linkedSites': 'https://demo.docusign.net'No parameters
click/get_v1_accounts_by_account_id_clickwrapsGets all the clickwraps for an account.accountId (string)
from_date (string)
ownerUserId (string)
page_number (string)
shared (string)
status (string)
to_date (string)
click/post_v1_accounts_by_account_id_clickwrapsCreates a clickwrap for an account and returns the response with created agreement.accountId (string)
data: {
. clickwrapName (string)
. displaySettings
. documents (array)
. fieldsToNull (string)
. isMajorVersion (boolean)
. isShared (boolean)
. name (string)
. requireReacceptance (boolean)
. scheduledDate (object)
. scheduledReacceptance
. status (object)
. transferFromUserId (string)
. transferToUserId (string)
} (object) required
click/delete_v1_accounts_by_account_id_clickwrapsDeletes all clickwraps for an account or only the ones specified in the clickwrapIds query parameter.accountId (string)
clickwrapIds (string)
click/get_v1_accounts_by_account_id_clickwraps_by_clickwrap_idGets a single clickwrap object.accountId (string)
clickwrapId (string)
click/put_v1_accounts_by_account_id_clickwraps_by_clickwrap_idUpdates the user ID of a clickwrap. You specify the old and the new user ID in the request body.accountId (string)
clickwrapId (string)
data: {
. transferFromUserId (string)
. transferToUserId (string)
} (object) required
click/delete_v1_accounts_by_account_id_clickwraps_by_clickwrap_idDeletes the clickwrap specified by clickwrapId and all of its versions. Active clickwraps are not deletedaccountId (string)
clickwrapId (string)
versions (string)
click/post_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_agreementsChecks if a user has agreed to a clickwrap and returns a response with the agreement URL. Returns HTTP status code OK if the user has no pending agreement.accountId (string)
clickwrapId (string)
data: {
. clientUserId (string)
. hostOrigin (string)
. metadata (string)
} (object) required
click/get_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_agreements_by_agreement_idGets the agreement specified by agreementId. You can omit agreementId to get the latest agreement.accountId (string)
agreementId (string)
clickwrapId (string)
click/get_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_agreements_by_agreement_id_downloadGets the PDF of agreementId for the clickwrap specified by ciickwrapId. The response to this method is the bytes of the PDF file. The response includes the HTTP header application/pdf.accountId (string)
agreementId (string)
clickwrapId (string)
click/get_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_usersGet user agreementsaccountId (string)
clickwrapId (string)
client_user_id (string)
from_date (string)
page_number (string)
status (string)
to_date (string)
click/post_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versionsCreates a new clickwrap version.accountId (string)
clickwrapId (string)
data: {
. clickwrapName (string)
. displaySettings
. documents (array)
. fieldsToNull (string)
. isMajorVersion (boolean)
. isShared (boolean)
. name (string)
. requireReacceptance (boolean)
. scheduledDate (object)
. scheduledReacceptance
. status (object)
. transferFromUserId (string)
. transferToUserId (string)
} (object) required
click/delete_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versionsDeletes all versions of a clickwrap, or only the ones specified in the clickwrapVersionIds query parameter.accountId (string)
clickwrapId (string)
clickwrapVersionIds (string)
click/get_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versions_by_version_idGets the version specified by versionId from the clickwrap clickwrapId.accountId (string)
clickwrapId (string)
versionId (string)
click/put_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versions_by_version_idUpdates the clickwrap version versionId of the clickwrap clickwrapId.accountId (string)
clickwrapId (string)
versionId (string)
data: {
. clickwrapName (string)
. displaySettings
. documents (array)
. fieldsToNull (string)
. isMajorVersion (boolean)
. isShared (boolean)
. name (string)
. requireReacceptance (boolean)
. scheduledDate (object)
. scheduledReacceptance
. status (object)
. transferFromUserId (string)
. transferToUserId (string)
} (object) required
click/delete_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versions_by_version_idDeletes the clickwrap version versionId of the clickwrap clickwrapId.accountId (string)
clickwrapId (string)
versionId (string)
click/get_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versions_by_version_id_usersGets the agreement responses for a specific version.accountId (string)
clickwrapId (string)
versionId (string)
client_user_id (string)
from_date (string)
page_number (string)
status (string)
to_date (string)
click/get_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versions_by_version_numberGets the clickwrap version specified by versionNumber from the clickwrap clickwrapId.accountId (string)
clickwrapId (string)
versionNumber (string)
click/put_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versions_by_version_numberUpdates the clickwrap version specified by versionNumber of the clickwrap clickwrapId.accountId (string)
clickwrapId (string)
versionNumber (string)
data: {
. clickwrapName (string)
. displaySettings
. documents (array)
. fieldsToNull (string)
. isMajorVersion (boolean)
. isShared (boolean)
. name (string)
. requireReacceptance (boolean)
. scheduledDate (object)
. scheduledReacceptance
. status (object)
. transferFromUserId (string)
. transferToUserId (string)
} (object) required
click/delete_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versions_by_version_numberDeletes the clickwrap version specified by versionNumber from the clickwrap clickwrapId.accountId (string)
clickwrapId (string)
versionNumber (string)
click/get_v1_accounts_by_account_id_clickwraps_by_clickwrap_id_versions_by_version_number_usersGets the agreement responses for a clickwrap versionaccountId (string)
clickwrapId (string)
versionNumber (string)
client_user_id (string)
from_date (string)
page_number (string)
status (string)
to_date (string)
rooms/get_v2_accounts_by_account_idReturns details about a company account.accountId (string)
rooms/get_v2_accounts_by_account_id_documents_by_document_idReturns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format. To find the documentId of the document that you want to retrieve, use the Rooms: GetDocuments method.documentId (integer)
accountId (string)
includeContents (boolean)
rooms/delete_v2_accounts_by_account_id_documents_by_document_idPermanently deletes a document. To find the documentId of a document that you want to delete, use the Rooms: GetDocuments method. If the document is deleted successfully, the HTTP response code is 204 No Content, so the response body is empty.documentId (integer)
accountId (string)
rooms/post_v2_accounts_by_account_id_documents_by_document_id_usersGrants a user access to a document. You specify the user's userId in the request body. The response is an object that specifies the access the user has.documentId (integer)
accountId (string)
data: {
. userId (integer)
} (object) required
rooms/get_v2_accounts_by_account_id_esign_permission_profilesWhen you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This method returns a list of the eSignature permission profiles that the current user may be able to assign to a new member. The current user may not assign a permission higher than their own permission.accountId (string)
rooms/post_v2_accounts_by_account_id_external_form_fill_sessionsReturns a URL for a new external form fill session, based on the roomId and formId that you specify in the formFillSessionForCreate request body.accountId (string)
data: {
. formId (string)
. roomId (integer)
. formIds (array)
. xFrameAllowedUrl (string)
} (object) required
rooms/get_v2_accounts_by_account_id_field_sets_by_field_set_idReturns a field set. This is a set of fields that can appear on a room's Details tab in the console, such as contactName and phone.fieldSetId (string)
accountId (string)
fieldsCustomDataFilters (array)
rooms/get_v2_accounts_by_account_id_form_groupsReturns the company form groups to which the current user has access. Permissions You must have a role for which the canManageFormGroups permission is set to true.accountId (string)
count (integer)
startPosition (integer)
rooms/post_v2_accounts_by_account_id_form_groupsCreates a new form group with the name given in the name property of the request body. Permissions You must have a role for which the canManageFormGroups permission is set to true.accountId (string)
data: {
. name (string)
} (object) required
rooms/get_v2_accounts_by_account_id_form_groups_by_form_group_idGet the specified form group. Permissions You must have a role for which the canManageFormGroups permission is set to true.formGroupId (string)
accountId (string)
rooms/put_v2_accounts_by_account_id_form_groups_by_form_group_idRenames the specified form group with the name given in the name property of the request. Permissions You must have a role for which the canManageFormGroups permission is set to true.formGroupId (string)
accountId (string)
data: {
. name (string)
} (object) required
rooms/delete_v2_accounts_by_account_id_form_groups_by_form_group_idDeletes the specified form group. Permissions You must have a role for which the canManageFormGroups permission is set to true.formGroupId (string)
accountId (string)
rooms/get_v2_accounts_by_account_id_form_groups_by_form_group_id_formsGet forms of the specified form group.formGroupId (string)
accountId (string)
count (integer)
startPosition (integer)
rooms/post_v2_accounts_by_account_id_form_groups_by_form_group_id_unassign_form_by_form_idRemoves the form formId from the form group formGroupId. Permissions You must have a role for which the canManageFormGroups permission is set to true.formGroupId (string)
formId (string)
accountId (string)
rooms/post_v2_accounts_by_account_id_form_groups_by_form_group_id_assign_formAssigns the form specified in the formId property of the request to the form group formGroupId. Set the isRequired property in the request body to true if this is a required form. Permissions You must have a role for which the canManageFormGroups permission is set to true.formGroupId (string)
accountId (string)
data: {
. formId (string)
. isRequired (boolean)
} (object) required
rooms/post_v2_accounts_by_account_id_form_groups_by_form_group_id_grant_office_access_by_office_idGrants the office officeId access to the form group formGroupId. Permissions You must have a role for which the canManageFormGroups permission is set to true.formGroupId (string)
officeId (integer)
accountId (string)
rooms/post_v2_accounts_by_account_id_form_groups_by_form_group_id_revoke_office_access_by_office_idRevoke access to the form group formGroupId from the office officeId. Permissions You must have a role for which the canManageFormGroups permission is set to true.formGroupId (string)
officeId (integer)
accountId (string)
rooms/get_v2_accounts_by_account_id_form_librariesReturns a list of form libraries to which the current user has access. Permissions All users can use this method, but the results will differ based on whether the company has asked DocuSign to enable RequireOfficeLibraryAssignments functionality. If this functionality is enabled for the account, then the list is filtered based on the offices that the user is in and the libraries that are assigned to those offices. When RequireOfficeLibraryAssignments is not enabled, the API returns all resaccountId (string)
count (integer)
startPosition (integer)
rooms/get_v2_accounts_by_account_id_form_libraries_by_form_library_id_formsReturns a list of forms to which the current user has access in the specified form library.formLibraryId (string)
accountId (string)
count (integer)
startPosition (integer)
rooms/get_v2_accounts_by_account_id_form_providers_by_provider_id_associationsGets all associations by provider.providerId (string)
accountId (string)
count (integer)
startPosition (integer)
rooms/get_v2_accounts_by_account_id_forms_by_form_id_detailsReturns details about a specific form, such as the date it was created and last updated, the number of pages, the form owner, and other information.formId (string)
accountId (string)
rooms/get_v2_countriesReturns a list of countries that the API supports. This is a list of countries in which you can create an office. You do not specify an accountId or any other parameters with this method. Permissions Any user with a valid access token can use this method.No parameters
rooms/get_v2_closing_statusesReturns a list of closing statuses, or valid reasons for closing a room. You do not specify an accountId or any other parameters with this method. Permissions Any user with a valid access token can use this method.No parameters
rooms/get_v2_contact_sidesReturn a list of valid values for transaction contact sides. Note: You do not specify an accountId or any other parameters with this method. Permissions Any user who has a valid access token can use this method.No parameters
rooms/get_v2_financing_typesReturns a list of possible financing types. Permissions Any user with a valid access token can use this method.No parameters
rooms/get_v2_origins_of_leadsReturns a list of origins of leads such as Trulia or Zillow that you can specify for rooms. Permissions Anyone with a valid access token can call this method.No parameters
rooms/get_v2_property_typesReturns a list of property types. Permissions Anyone with a valid access token can call this method.No parameters
rooms/get_v2_room_contact_typesReturns a list of room contact types, such as Buyer, Seller, and Listing Agent. Permissions Anyone with a valid access token can call this method.No parameters
rooms/get_v2_seller_decision_typesReturns a list of possible seller decision types regarding offers, such as Countered or Rejected. Permissions Any user with a valid access token can use this method.No parameters
rooms/get_v2_special_circumstance_typesReturns a list of special circumstance types, such as Short Sale and Foreclosure. These are the values that you can select for the Special circumstances field that appears on the Room Details page. Permissions Anyone with a valid access token can call this method.No parameters
rooms/get_v2_task_date_typesReturns a list of date types that you can use with tasks, such as Actual Close Date and Task Due Date. These are the options that appear in the Due Date drop-down list when you create a task by using the console. Note: You do not enter an accountId with this method. Permissions Any user with a valid access token can use this method.No parameters
rooms/get_v2_task_responsibility_typesReturns a list of responsibility types that you can assign to users when you add them to a task. Note: You do not specify an accountId with this method. Permissions Any user with a valid access token can call this method.No parameters
rooms/get_v2_task_statusesReturns a list of valid task statuses.No parameters
rooms/get_v2_transaction_sidesReturns a list of real estate transaction sides. Permissions Any user with a valid access token can use this method.No parameters
rooms/get_v2_statesReturns a list of states. Note: You do not enter an accountId with this method. Permissions Anyone with a valid access token can call this method.No parameters
rooms/get_v2_currenciesReturns a list of valid values for the currencies that you can use for listing, offer, and loan amounts. Note: You do not specify an accountId with this method. Permissions Any user with a valid access token can use this method.No parameters
rooms/get_v2_time_zonesGets a list of time zones that you can assign to an office. Note: You do not specify an accountId with this method. Permissions Anyone with a valid access token can call this method.No parameters
rooms/get_v2_accounts_by_account_id_officesThis method returns a list of offices associated with an account.accountId (string)
count (integer)
startPosition (integer)
onlyAccessible (boolean)
search (string)
rooms/post_v2_accounts_by_account_id_officesThis method creates an office in a Rooms account. You can configure the following information for the new office: - Office name - Region - Address - Country ID and time zone - Phone number When you create an office, the Rooms API service assigns it an ID officeId and timestamp createdDate, which are returned in the response along with the above data elements you specified. See the Offices object for descriptions of these data elements. Use the Users: AddUserToOffice/docs/rooms-api/reference/uaccountId (string)
data: {
. name (string)
. regionId (integer)
. address1 (string)
. address2 (string)
. city (string)
. stateId (string)
. postalCode (string)
. countryId (string)
. timeZoneId (string)
. phone (string)
} (object) required
rooms/get_v2_accounts_by_account_id_offices_by_office_idThis method returns information about an office.officeId (integer)
accountId (string)
rooms/delete_v2_accounts_by_account_id_offices_by_office_idThis method deletes an office from a Rooms account.officeId (integer)
accountId (string)
rooms/get_v2_accounts_by_account_id_offices_by_office_id_reference_countsThis method returns a list of each type of object and the number of objects of that type referencing the specified office. Note that an office cannot be deleted while existing objects reference it.officeId (integer)
accountId (string)
rooms/post_v2_accounts_by_account_id_regionsThis method creates a new region. When you create a region, you specify only the name. The service will assign and return a region ID regionId and a creation timestamp createdDate.accountId (string)
data: {
. regionId (integer)
. name (string)
. createdDate (string)
} (object) required
rooms/get_v2_accounts_by_account_id_regionsThis method returns a list of regions that are associated with a Rooms account.accountId (string)
count (integer)
startPosition (integer)
managedOnly (boolean)
rooms/get_v2_accounts_by_account_id_regions_by_region_idThis method returns information about a specific region.regionId (integer)
accountId (string)
rooms/delete_v2_accounts_by_account_id_regions_by_region_idThis method deletes a region from a Rooms account.regionId (integer)
accountId (string)
rooms/get_v2_accounts_by_account_id_regions_by_region_id_reference_countsThis method returns a list of each type of object and the number of objects of that type referencing the specified region. Note: A region cannot be deleted while existing objects reference it.regionId (integer)
accountId (string)
rooms/post_v2_accounts_by_account_id_rolesCreates a new company role. Permissions To use this method, you must have the canManageAccount permission set to true.accountId (string)
data: {
. name (string)
. isExternal (boolean)
. permissions
} (object) required
rooms/get_v2_accounts_by_account_id_rolesReturns a list of roles associated with a company account. Permissions Any user with a valid access token can call this method.accountId (string)
onlyAssignable (boolean)
filterContext (undefined)
filter (string)
startPosition (integer)
count (integer)
rooms/get_v2_accounts_by_account_id_roles_by_role_idReturns details about a role, including the associated permissions.roleId (integer)
accountId (string)
includeIsAssigned (boolean)
rooms/put_v2_accounts_by_account_id_roles_by_role_idModifies the specified company role. Permissions To use this method, you must have the canManageAccount permission set to true.roleId (integer)
accountId (string)
data: {
. name (string)
. isExternal (boolean)
. permissions
} (object) required
rooms/delete_v2_accounts_by_account_id_roles_by_role_idDeletes a role from a company account. Permissions To use this method, you must have the canManageAccount permission set to true.roleId (integer)
accountId (string)
rooms/post_v2_accounts_by_account_id_rooms_by_room_id_envelopesCreates an envelope with the given documents. Returns the eSignature envelope ID of the envelope that was created.roomId (integer)
accountId (string)
data: {
. envelopeName (string)
. documentIds (array)
} (object) required
rooms/get_v2_accounts_by_account_id_rooms_by_room_id_field_dataReturns the field data associated with a room. This is the information that appears on the room's Details tab. To better understand the room's field data, use the Rooms: GetRoomFieldSet/docs/rooms-api/reference/rooms/rooms/getroomfieldset/ method to retrieve the set of fields that the room uses.roomId (integer)
accountId (string)
rooms/put_v2_accounts_by_account_id_rooms_by_room_id_field_dataThis method lets you update one or more fields in a room's field data, the information that appears in the room's Details tab. To better understand the room's field data, use the Rooms: GetRoomFieldSet/docs/rooms-api/reference/rooms/rooms/getroomfieldset/ method to retrieve the set of fields that the room uses. To get the current values of a room's field data, use Rooms: GetRoomFieldData/docs/rooms-api/reference/rooms/rooms/getroomfieldset/. For example, to update the 'Tax annual amount' and BroomId (integer)
accountId (string)
data: {
. data (object)
} (object) required
rooms/get_v2_accounts_by_account_id_rooms_by_room_id_room_foldersGets a list of room folders in the specified room that are accessible to the current user.roomId (integer)
accountId (string)
startPosition (integer)
count (integer)
rooms/post_v2_accounts_by_account_id_rooms_by_room_id_formsAdds a form to a room. You specify the form that you want to add in the formForAdd request body. To find the ID of the form that you want to add, use the FormsLibraries: GetFormLibraryForms methodGetFormLibraryForms. GetFormLibraryForms: /docs/rooms-api/reference/Forms/FormLibraries/GetFormLibraryForms/ Permissions You must have a role for which the canAddDocumentsFromFormLibraries permission is set to true.roomId (integer)
accountId (string)
data: {
. formId (string)
} (object) required
rooms/post_v2_accounts_by_account_id_rooms_by_room_id_usersThis method invites an existing or new member to a specific room. You can invite anyone to join a room by specifying their email address.roomId (integer)
accountId (string)
data: {
. email (string)
. firstName (string)
. lastName (string)
. roleId (integer)
. transactionSideId (string)
} (object) required
rooms/get_v2_accounts_by_account_id_rooms_by_room_id_usersThis method returns a list of users associated with a room.roomId (integer)
accountId (string)
count (integer)
startPosition (integer)
filter (string)
sort (undefined)
rooms/put_v2_accounts_by_account_id_rooms_by_room_id_users_by_user_idYou can use this method to update the following information for a room user: - roleId - transactionSideId In the console, this is the Side and role information that appears in the room's People tab. You specify the information that you want to update in the roomUserForUpdate request body. Permissions Only the person who invited the room user to the room can update the room user.roomId (integer)
userId (integer)
accountId (string)
data: {
. roleId (integer)
. transactionSideId (string)
} (object) required
rooms/post_v2_accounts_by_account_id_rooms_by_room_id_users_by_user_id_revoke_accessRevokes the specified user's access to the room. If successful, the HTTP result is 204 No content, and the response is empty. To revoke access immediately, leave the request body empty. To revoke access on a specific date, use the request body to specify a date. Note If a user doesn't have access to a room, and you revoke their access at a future date, the user will be granted access until the revocation date.roomId (integer)
userId (integer)
accountId (string)
data: {
. revocationDate (string)
} (object) required
rooms/post_v2_accounts_by_account_id_rooms_by_room_id_users_by_user_id_restore_accessRestores the specified user's access to the room.roomId (integer)
userId (integer)
accountId (string)
rooms/get_v2_accounts_by_account_id_roomsThis method returns details about the rooms that the current user has permissions to view. The fieldDataChangedStartDate and fieldDataChangedEndDate query parameters let you limit the results to rooms whose field data/docs/rooms-api/reference/rooms/rooms/getroomfielddata/ has changed within a range of dates. The roomClosedStartDate and roomClosedEndDate query parameters let you limit the results to rooms that were closed within a range of dates. Note: By default, this method only returns openaccountId (string)
count (integer)
startPosition (integer)
roomStatus (undefined)
officeId (integer)
fieldDataChangedStartDate (string)
fieldDataChangedEndDate (string)
roomClosedStartDate (string)
roomClosedEndDate (string)
rooms/post_v2_accounts_by_account_id_roomsThis method creates a new room. Note: To use this method, your company must have at least one office set up. Permissions You must be assigned to a role that has the Create Rooms permission set to true.accountId (string)
data: {
. name (string)
. roleId (integer)
. transactionSideId (string)
. ownerId (integer)
. templateId (integer)
. officeId (integer)
. fieldData
. listingSource (string)
} (object) required
rooms/get_v2_accounts_by_account_id_rooms_by_room_idThis method returns details about a specific room.roomId (integer)
accountId (string)
includeFieldData (boolean)
rooms/delete_v2_accounts_by_account_id_rooms_by_room_idThis method deletes a room. Note: To use this method, you must be assigned a role that has the Delete Owned Rooms permission set to true in the console. If you manage other members, this permission also enables you to delete rooms that are owned by the users that you manage.roomId (integer)
accountId (string)
rooms/get_v2_accounts_by_account_id_rooms_by_room_id_assignable_rolesThis method returns the room-level roles that the current user can assign to the members that they invite to a room. Note: This method works only for Rooms v6 and only returns roles that have isExternal set to true.roomId (integer)
accountId (string)
assigneeEmail (string)
filter (string)
startPosition (integer)
count (integer)
rooms/post_v2_accounts_by_account_id_rooms_by_room_id_documentsAdds a document to a room. The following properties in the request body are required. The folderId property is optional. All other properties are ignored. - name - base64Contents If a document with the specified name already exists, a counter is added to the name to make it unique. For example, to create a document named hello.txt that contains the text hello, world, the body of your request would look like this: 'name': 'hello.txt', 'base64Contents': 'aGVsbG8sIHdvcmxkCg=='roomId (integer)
accountId (string)
data: {
. documentId (integer)
. name (string)
. roomId (integer)
. ownerId (integer)
. size (integer)
. folderId (integer)
. createdDate (string)
. isSigned (boolean)
. contentType (string)
. base64Contents (string)
. isDynamic (boolean)
} (object) required
rooms/get_v2_accounts_by_account_id_rooms_by_room_id_documentsThis method returns a list of documents that the current user can access for a specific room.roomId (integer)
accountId (string)
count (integer)
startPosition (integer)
requireContentForDynamicDocuments (boolean)
roomFolderId (integer)
nameFilter (string)
includeArchived (boolean)
rooms/post_v2_accounts_by_account_id_rooms_by_room_id_documents_contentsThis method uploads the contents of file as a room document for the room that you specify. This is a multipart form request. You must include the following headers: - Content-Type: multipart/form-data with a boundary - Content-Disposition: form-data - Content-Disposition: file with the filename Related topics - How to attach documents via binary transfer eSignature/docs/esign-rest-api/how-to/send-binary/ An eSignature API example that illustrates how to build a multi-part JSON requestroomId (integer)
accountId (string)
rooms/put_v2_accounts_by_account_id_rooms_by_room_id_pictureUpdates the photo for a room. The image file size limit is approximately 40 MB, and you can use the following image formats: - jpg/jpeg - png - tiff - gif In the request body of this endpoint, you can specify the image as: - a JSON object - multipart form data - stream data To upload an image as a JSON object, use an object with two string properties: - fileName: the name of the file - base64Contents: the base64 representation of the image. For example a cURL request might look like this:roomId (integer)
accountId (string)
rooms/get_v2_accounts_by_account_id_rooms_by_room_id_field_setReturns the field set that a room uses. This is the set of fields that appears on the room's Details tab in the console, such as contactName and phone. You can use this method to gain a better understanding of the room field data retrieved with the Rooms: GetRoomFieldData/docs/rooms-api/reference/rooms/rooms/getroomfielddata/ method, and to determine the fields for which you can provide data when you create a new room. Permissions Anyone in the room can call this method.roomId (integer)
accountId (string)
rooms/get_v2_accounts_by_account_id_rooms_by_room_id_task_listsReturns the task lists associated with a room. Permissions You must either be a member of the room who has been added to one or more tasks, or have one of the following permissions set to true: - canAddTasksToAnyTaskLists - canApplyTaskList - canRemoveAnyTaskList - canSubmitTaskList - canReviewTaskList Note: If a room has multiple tasks lists, you only see the task lists that contain tasks to which you have been added.roomId (integer)
accountId (string)
rooms/post_v2_accounts_by_account_id_rooms_by_room_id_task_listsApplies a task list to a room, based on the taskTemplateId that you specify in the taskList request body. Note: You must first create a task list template in the console. You cannot create a task list template by using the API at this time. To get the taskListTemplateId, use the TaskListTemplates: GetTaskListTemplates method. Permissions You must have the canApplyTaskList permission set to true.roomId (integer)
accountId (string)
data: {
. taskListTemplateId (integer)
} (object) required
rooms/get_v2_accounts_by_account_id_room_templatesThis method returns a list of room templates that the user can use to create a new room. The response includes company and region-level templates.accountId (string)
officeId (integer)
onlyAssignable (boolean)
onlyEnabled (boolean)
count (integer)
startPosition (integer)
rooms/delete_v2_accounts_by_account_id_task_lists_by_task_list_idDeletes the specified task list from a room. If there are attached documents, they will remain in the associated room. Permissions You must have the canRemoveAnyTaskList permission set to true.taskListId (integer)
accountId (string)
rooms/get_v2_accounts_by_account_id_task_list_templatesReturns all task list templates associated with the active user's company. Permissions Anyone with a valid access token can call this method.accountId (string)
startPosition (integer)
count (integer)
rooms/get_v2_accounts_by_account_id_usersReturns a list of users associated with an account based on the criteria that you specify.accountId (string)
filter (string)
sort (undefined)
defaultOfficeId (integer)
accessLevel (undefined)
titleId (integer)
roleId (integer)
status (undefined)
lockedOnly (boolean)
startPosition (integer)
count (integer)
rooms/get_v2_accounts_by_account_id_users_by_user_idReturns details about the specified user.userId (integer)
accountId (string)
rooms/put_v2_accounts_by_account_id_users_by_user_idChanges a user's default office. This is the office to which the user belongs by default. Permissions You must have at least one of the following permissions set to true, depending on the level of the user that you want to update: - canManageMemberLowerAccessLevel: Users can modify other users who have a lower access level than their own in offices or regions that they oversee. - canManageMemberSameAccessLevel: Users can modify other users who have the same access level as their own in ofuserId (integer)
accountId (string)
data: {
. defaultOfficeId (integer)
} (object) required
rooms/delete_v2_accounts_by_account_id_users_by_user_idRemoves the specified user from the specified account. Permissions To remove a user who has a lower access level, you must have the canRemoveCompanyMemberLowerAccessLevel permission set to true. To remove a user who has the same access level, you must have the canRemoveCompanyMemberSameAccessLevel permission set to true.userId (integer)
accountId (string)
rooms/post_v2_accounts_by_account_id_users_invite_userInvites a new user to join a company account. You specify the custom role and access level that you want to give to the user in the invitee request body. Permissions To invite users to a company, you must be either a Default Admin or another authorized user who has access to all of the locations to which the new user is being invited and one of the following userPermissions set to true: - canAddMemberAndSetRoleLowerAccessLevel: Users can add other users who have a lower access level than taccountId (string)
data: {
. firstName (string)
. lastName (string)
. email (string)
. roleId (integer)
. accessLevel (string)
. defaultOfficeId (integer)
. regions (array)
. offices (array)
. subscribeToRoomsActivityNotifications (boolean)
. eSignPermissionProfileId (string)
. redirectUrl (string)
} (object) required
rooms/post_v2_accounts_by_account_id_users_by_user_id_reinviteReinvites an unactivated user to join a company account. Invitations expire after 30 days and can no longer be accepted. Use this method to send a new copy of an invitation to a pending user.userId (integer)
accountId (string)
rooms/post_v2_accounts_by_account_id_users_by_user_id_add_to_officeAdds an existing user to a single office. You specify the office to which you want to add the user in the designatedOffice request body. To add a user to multiple offices, you must make this call separately for each office. Note: The accessLevel of the user that you are adding must be contributor or office. Permissions You must have at least one of the following permissions set to true, depending on the level of the user that you want to add or remove: - canManageMemberLowerAccessLevel:userId (integer)
accountId (string)
data: {
. officeId (integer)
} (object) required
rooms/post_v2_accounts_by_account_id_users_by_user_id_remove_from_officeRemoves a user from a single office. You specify the office from which you want to remove the user in the designatedOffice request body. The user still maintains their other office, region, company, and account associations. Note: You cannot remove a user from their default office. You must first assign the user a different default office by using the Users: updateUserupdateUser method. updateUser: /docs/rooms-api/reference/Users/Users/UpdateUser/ Permissions You must have at least one ouserId (integer)
accountId (string)
data: {
. officeId (integer)
} (object) required
rooms/post_v2_accounts_by_account_id_users_by_user_id_add_to_regionAdds an existing user to a region. You specify the region to which you want to add the user in the designatedRegion request body. To add a user to multiple regions, you must make this call separately for each region. Note: The accessLevel of the user that you are adding must be region. Permissions You must have at least one of the following permissions set to true, depending on the level of the user that you want to add or remove: - canManageMemberLowerAccessLevel: Users can add or removuserId (integer)
accountId (string)
data: {
. regionId (integer)
} (object) required
rooms/post_v2_accounts_by_account_id_users_by_user_id_remove_from_regionRemoves a user from a single region. You specify the region from which you want to remove the user in the designatedRegion request body. The user still maintains their other region, company, and account associations. Permissions You must have at least one of the following permissions set to true, depending on the level of the user that you want to add or remove: - canManageMemberLowerAccessLevel: Users can add or remove other users who have a lower access level than their own in offices ouserId (integer)
accountId (string)
data: {
. regionId (integer)
} (object) required
rooms/post_v2_accounts_by_account_id_users_by_user_id_lockLocks the account of the specified user. Use the reason property in the request body to specify why the account was locked. Permissions To lock a user who has a lower access level than you, you must have the canManageMemberLowerAccessLevel permission set to true. To lock a user who has the same access level as you, you must have the canManageMemberSameAccessLevel permission set to trueuserId (integer)
accountId (string)
data: {
. reason (string)
} (object) required
rooms/post_v2_accounts_by_account_id_users_by_user_id_unlockUnlocks the account of the specified user. Permissions - To unlock a user who has a lower access level than you, you must have the canManageMemberLowerAccessLevel permission set to true. - To unlock a user who has the same access level as you, you must have the canManageMemberSameAccessLevel permission set to true.userId (integer)
accountId (string)
monitor/get_api_vby_version_datasets_by_data_set_name_streamGets customer event data for the organization that owns the integration key. Use the limit query parameter to limit the number of records returned.dataSetName (string)
version (string)
cursor (string)
limit (integer)
webforms/get_v1_1_accounts_by_account_id_formsds-inlinemessageThe Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Supporthttps://support.docusign.com/s/?language=en_US or your account manager to find out whether the Web Forms API is available for your production account plan./ds-inlinemessage This method returns a list of web form configurations for a given account. Use the query parameters to sort and filter the response. Required authentication scopes/docs/web-forms-aaccountId (string)
user_filter (string)
is_standalone (boolean)
is_published (boolean)
sort_by (string)
search (string)
start_position (string)
count (string)
webforms/get_v1_1_accounts_by_account_id_forms_by_form_idds-inlinemessageThe Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Supporthttps://support.docusign.com/s/?language=en_US or your account manager to find out whether the Web Forms API is available for your production account plan./ds-inlinemessage Retrieves a web form configuration. If you make changes to an active form configuration, the unchanged active version will also be maintained. The two versions will have the same faccountId (string)
formId (string)
state (string)
webforms/get_v1_1_accounts_by_account_id_forms_by_form_id_instancesds-inlinemessageThe Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Supporthttps://support.docusign.com/s/?language=en_US or your account manager to find out whether the Web Forms API is available for your production account plan./ds-inlinemessage Retrieves all the instances of a given web form configuration. Required authentication scopes/docs/web-forms-api/plan-integration/authentication/: webforms_instance_read.accountId (string)
formId (string)
client_user_id (string)
webforms/post_v1_1_accounts_by_account_id_forms_by_form_id_instancesds-inlinemessageThe Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Supporthttps://support.docusign.com/s/?language=en_US or your account manager to find out whether the Web Forms API is available for your production account plan./ds-inlinemessage Creates an instance of a web form. This endpoint returns a formUrl and instanceToken that you combine to obtain a secure URL. Use this URL to render the web form instance in your aaccountId (string)
formId (string)
data: {
. formValues
. clientUserId
. authenticationInstant
. authenticationMethod
. assertionId
. securityDomain
. returnUrl
. expirationOffset
. sendOption
. recipients (array)
. tags (array)
} (object) required
webforms/get_v1_1_accounts_by_account_id_forms_by_form_id_instances_by_instance_idds-inlinemessageThe Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Supporthttps://support.docusign.com/s/?language=en_US or your account manager to find out whether the Web Forms API is available for your production account plan./ds-inlinemessage Gets an instance of a web form specified by the configuration and instance IDs. To get all instances associated with a given configuration, use the listInstances endpoint/docs/web-faccountId (string)
formId (string)
instanceId (string)
webforms/post_v1_1_accounts_by_account_id_forms_by_form_id_instances_by_instance_id_refreshds-inlinemessageThe Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Supporthttps://support.docusign.com/s/?language=en_US or your account manager to find out whether the Web Forms API is available for your production account plan./ds-inlinemessage Generates a new instance token for an existing web form instance. Tokens expire after five minutes. Required authentication scopes/docs/web-forms-api/plan-integration/authenticatioaccountId (string)
formId (string)
instanceId (string)
navigator/get_v1_accounts_by_account_id_agreementsNo description availableaccountId (string)
limit (integer)
ctoken (string)
$filter (string)
sort (string)
direction (string)
id (string)
document_id (string)
status (string)
review_status (string)
review_completed_at (string)
parties.name_in_agreement (string)
metadata.created_at (string)
title (string)
related_agreement_documents.parent_agreement_document_id (string)
languages (string)
provisions.effective_date (string)
provisions.expiration_date (string)
provisions.execution_date (string)
provisions.term_length (string)
source_name (string)
source_id (string)
navigator/get_v1_accounts_by_account_id_agreements_by_agreement_idNo description availableaccountId (string)
agreementId (string)
navigator/delete_v1_accounts_by_account_id_agreements_by_agreement_idNo description availableaccountId (string)
agreementId (string)
navigator/post_v1_accounts_by_account_id_upload_jobsNo description availableaccountId (string)
data: {
. job_name (string)
. expected_number_of_docs (integer)
. language (string)
. agreement_set_ids (array)
} (object) required
navigator/get_v1_accounts_by_account_id_upload_jobs_by_job_idNo description availableaccountId (string)
jobId (string)
navigator/post_v1_accounts_by_account_id_upload_jobs_by_job_id_actions_completeNo description availableaccountId (string)
jobId (string)
maestro/get_workflowsThis operation retrieves a list of all available Maestro workflows. It returns basic information about each workflow, including its unique identifier id, name, description, and the input schema required to trigger the workflow. The response provides key details that help users identify which workflows are available and understand the input requirements for triggering each one. Each workflow entry also includes metadata, such as when it was created, last modified, and by whom. This operatioNo parameters
maestro/get_workflows_by_workflow_id_trigger_requirementsThis operation retrieves the configuration and input requirements necessary to trigger a specific Maestro workflow. It provides detailed information about the trigger_event_type, such as HTTP or other supported types, and specifies the required input schema, including field names, data types, and any default values. This information is essential for understanding the data and parameters required to initiate the workflow. It enables developers to prepare the necessary inputs and configuratiworkflowId (undefined)
maestro/post_workflows_by_workflow_id_actions_triggerThis operation triggers a new instance of a specified Maestro workflow. When invoked, the workflow is started based on the provided input data, and the workflow instance begins executing according to its defined logic and configuration. The request requires an instance_name and any input data necessary to start the workflow, as described by the workflow's trigger_input_schema. The instance_name is a user-defined label for tracking the workflow run, while the input data fields should match tworkflowId (undefined)
data: {
. instance_name (string)
. trigger_inputs (object)
} (object) required
connected_fields/get_accounts_by_account_id_connected_fields_tab_groupsReturns all tabs associated with the given account. Note: Unlike the Connected Fields UI, this endpoint returns only fields that are either mandatory or have the IsRequiredForVerifyingType a href='https://concerto.accordproject.org/docs/design/specification/model-decorators/' target='_blank'decorator/aaccountId (string)
appId (string)
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_brandThis operation retrieves details about a specific workspace. It returns the brand details such as its unique identifier ID, name, and metadata such as brand colors and logos.accountId (string)
workspaceId (string)
workspaces/put_v1_accounts_by_account_id_workspaces_by_workspace_id_brandThis operation updates brand for a specific workspace. It returns the brand details such as its unique identifier ID, name, and metadata such as brand colors and logos.accountId (string)
workspaceId (string)
data: {
. brand_id (string)
} (object) required
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_documentsThis operation retrieves the documents in the workspace that are accessible to the calling user. Documents may be added directly or automatically through tasks such as envelopes. Documents may be used to create envelopes. Pagination is supported by passing start_position and count in the request. The response will include resultSetSize, start_position, and end_position which may be utilized for subsequent requests.accountId (string)
workspaceId (string)
count (integer)
start_position (integer)
name_filter (string)
workspaces/post_v1_accounts_by_account_id_workspaces_by_workspace_id_documentsThis operation adds a document to a workspace via file contents upload. The file is passed in the request body as a multipart/form-data file. The file name is used as the document name. Once added, it may be used to create an envelope associated with the workspace.accountId (string)
workspaceId (string)
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_documents_by_document_idThis operation retrieves information about the document. The response includes the document ID, name, and metadata.accountId (string)
workspaceId (string)
documentId (string)
workspaces/delete_v1_accounts_by_account_id_workspaces_by_workspace_id_documents_by_document_idThis operation permanently deletes a document by ID.accountId (string)
workspaceId (string)
documentId (string)
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_documents_by_document_id_contentsThis operation retrieves the file contents of the document. The file is returned as a stream in the response body. The Content-Disposition response header contains the document name as the filename.accountId (string)
workspaceId (string)
documentId (string)
workspaces/post_v1_accounts_by_account_id_workspaces_by_workspace_id_upload_requestsThis operation creates a new upload request within a workspace. The upload request includes name, description, due date, and user assignments. Upload requests can be created as drafts or sent immediately based on the status field.accountId (string)
workspaceId (string)
data: {
. name (string)
. description (string)
. due_date (string)
. assignments (array)
. status
} (object) required
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_upload_requestsThis operation retrieves a list of upload requests within a workspace. Each upload request includes details such as ID, name, description, status, owner information, associated documents, assignments, and various dates.accountId (string)
workspaceId (string)
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_upload_requests_by_upload_request_idThis operation retrieves details about a specific upload request within a workspace. The response includes comprehensive information about the upload request including status, assigned users, associated documents, owner details, and various dates.accountId (string)
workspaceId (string)
uploadRequestId (string)
workspaces/put_v1_accounts_by_account_id_workspaces_by_workspace_id_upload_requests_by_upload_request_idThis operation updates a specific upload request within a workspace. Only draft upload requests can be edited. The editable fields are name, description, due date, and status. Status changes are restricted - only transitions from draft to in_progress are allowed. Attempting to update a non-draft upload request will result in an INVALID_STATUS error. Attempting an invalid status change will result in an INVALID_STATUS_CHANGE error.accountId (string)
workspaceId (string)
uploadRequestId (string)
data: {
. upload_request_id (string)
. workspace_id (string)
. name (string)
. description (string)
. upload_request_owner
. status
. documents (array)
. assignments (array)
. created_date (string)
. updated_date (string)
. due_date (string)
. sent_date (string)
. completed_date (string)
. can_view (boolean)
. can_edit (boolean)
. can_delete (boolean)
} (object) required
workspaces/delete_v1_accounts_by_account_id_workspaces_by_workspace_id_upload_requests_by_upload_request_idThis operation deletes a specific upload request within a workspace. Upload requests cannot be deleted if they are complete or have associated documents.accountId (string)
workspaceId (string)
uploadRequestId (string)
workspaces/post_v1_accounts_by_account_id_workspaces_by_workspace_id_upload_requests_by_upload_request_id_documentsThis operation adds a document to a specific upload request within a workspace via file upload. The file is passed in the request body as multipart/form-data. The file name is used as the document name.accountId (string)
workspaceId (string)
uploadRequestId (string)
workspaces/post_v1_accounts_by_account_id_workspaces_by_workspace_id_upload_requests_by_upload_request_id_actions_completeThis operation completes a specific upload request within a workspace and is intended to be called by the user completing the upload request. Only upload requests that are in progress can be completed.accountId (string)
workspaceId (string)
uploadRequestId (string)
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_usersThis operations retrieves the users in a workspace. Users sent envelopes or assigned tasks will automatically be added to the workspace with the Participate role. Pagination is supported by passing start_position and count in the request. The response will include resultSetSize, start_position, and end_position which may be utilized for subsequent requests.accountId (string)
workspaceId (string)
count (integer)
start_position (integer)
filter (string)
sort (string)
workspaces/post_v1_accounts_by_account_id_workspaces_by_workspace_id_usersThis operation manually adds an internal or external user to a specific workspace by email address. Users within the account are considered 'Internal' and may be assigned any role. Users outside the account are considered 'External' and may only be assigned the Participate role. This operation is not typically needed for adding external participants to a Workspace as they will be automatically added as tasks are assigned. Available role IDs can be retrieved via the Assignable Roles operation onaccountId (string)
workspaceId (string)
data: {
. email (string)
. first_name (string)
. last_name (string)
. role_id (string)
} (object) required
workspaces/put_v1_accounts_by_account_id_workspaces_by_workspace_id_users_by_user_idThis operation updates the specified user's role in the workspace. Users within the account are considered 'Internal' and may be assigned any role. Users outside the account are considered 'External' and may only be assigned 'External' roles.accountId (string)
workspaceId (string)
userId (string)
data: {
. role_id (string)
} (object) required
workspaces/post_v1_accounts_by_account_id_workspaces_by_workspace_id_users_by_user_id_actions_revoke_accessThis operation revokes the specified user's access to the workspace. The optional revocation_date may be set to schedule revocation in the future. If not specified, the revocation will be immediate.accountId (string)
workspaceId (string)
userId (string)
data: {
. revocation_date (string)
} (object) required
workspaces/post_v1_accounts_by_account_id_workspaces_by_workspace_id_users_by_user_id_actions_restore_accessThis operation restores the specified user's access to the workspace. The user must have been previously revoked from the workspace. The access is immediately restored.accountId (string)
workspaceId (string)
userId (string)
workspaces/get_v1_accounts_by_account_id_workspacesThis operation retrieves a list of workspaces available to the calling user. It returns basic information about each workspace, including its unique identifier ID, name, and metadata such as when it was created and by whom. Pagination is supported by passing start_position and count in the request. The response will include resultSetSize, start_position, and end_position which may be utilized for subsequent requests.accountId (string)
count (integer)
start_position (integer)
workspaces/post_v1_accounts_by_account_id_workspacesThis operation creates a new workspace. The calling user is automatically added as a member of the workspace with the role of Manage. Once created, the workspace_id is utilized to associate tasks such as envelopes. Participants on tasks will automatically be added to the workspace with the Participate role.accountId (string)
data: {
. name (string)
. brand_id (string)
} (object) required
workspaces/put_v1_accounts_by_account_id_workspaces_by_workspace_idThis operation updates details about a specific workspace. It returns the workspace's unique identifier ID, name, and metadata such as when it was created and by whom.accountId (string)
workspaceId (string)
data: {
. name (string)
} (object) required
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_idThis operation retrieves details about a specific workspace. It returns the workspace's unique identifier ID, name, and metadata such as when it was created and by whom.accountId (string)
workspaceId (string)
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_assignable_rolesThis operation returns roles that are assignable to users in the workspace based on the caller's role in the workspace. Roles available include Manage internal and Participate external. Participate is the default role. Users within the account are considered 'Internal' and may be assigned any role. Users outside the account are considered 'External' and may only be assigned 'External' roles. Pagination is supported by passing start_position and count in the request. The response will include raccountId (string)
workspaceId (string)
filter (string)
start_position (integer)
count (integer)
workspaces/post_v1_accounts_by_account_id_workspaces_by_workspace_id_envelopesThis operation creates an envelope associated with the workspace. Using the envelope_id from the response, the eSignature APIhttps://developers.docusign.com/docs/esign-rest-api/ may be utilized to modify the envelope and ultimately send it. Envelope recipients will automatically be granted Participate access to the workspace. Envelope recipients will receive consolidated notifications from Docusign Workspaces rather than standard individual envelope notifications. Docusign Connect events may baccountId (string)
workspaceId (string)
data: {
. envelope_name (string)
. document_ids (array)
} (object) required
workspaces/get_v1_accounts_by_account_id_workspaces_by_workspace_id_envelopesThis operation retrieves a list of all associated workspace envelopes. The statushttps://support.docusign.com/s/document-item?bundleId=oeq1643226594604 and topicId=wdm1578456348227.html on each envelope can be used to track envelope progress. Statuses are formatted as ProperCase. e.g. Sent, WaitingForOthers, Completed, etc. Based on the permissions of the caller, additional envelope details may be retrieved from the eSignature APIhttps://developers.docusign.com/docs/esign-rest-api/ using the enaccountId (string)
workspaceId (string)