From 1eb224350655983c606c96e981d29018679f3c60 Mon Sep 17 00:00:00 2001 From: acooper4960 Date: Thu, 20 Oct 2022 11:23:37 -0700 Subject: [PATCH] TIR - Updated esignature.rest.swagger-v2.1.json --- esignature.rest.swagger-v2.1.json | 4616 +++++++---------------------- 1 file changed, 1066 insertions(+), 3550 deletions(-) diff --git a/esignature.rest.swagger-v2.1.json b/esignature.rest.swagger-v2.1.json index 4e775b7..8f4e6ca 100644 --- a/esignature.rest.swagger-v2.1.json +++ b/esignature.rest.swagger-v2.1.json @@ -67,7 +67,7 @@ "Resources" ], "summary": "Lists resources for REST version specified", - "description": "Retrieves the base resources available for the eSignature REST API.\n\nYou do not need an integrator key to view the REST API versions and resources.\n\n", + "description": "Retrieves the base resources available for the eSignature REST API.\n\nYou do not need an integrator key to view the REST API versions and resources.\n\nExample: `https://demo.docusign.net/restapi/v2`\nlists all of the base resources available in version 2\nof the eSignature API on the DocuSign Demo system.\n\nTo view descriptions and samples of the service operations for all versions\nremove the version number and add /help to the URL.\n\nExample: `https://demo.docusign.net/restapi/help` lists the\neSignature API operations on the DocuSign Demo system\nwith XML and JSON request and response samples.", "operationId": "ServiceInformation_GetResourceInformation", "consumes": [], "produces": [], @@ -597,7 +597,7 @@ { "name": "include_metadata", "in": "query", - "description": "When **true,** the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to the `billingAddress` information. ", + "description": "When **true,** the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` is added to the `billingAddress` information. ", "required": false, "type": "string" }, @@ -726,9 +726,9 @@ }, "deprecated": false, "x-ds-methodname": "getCreditCardInfo", - "description": "This method returns information about a credit card associated with an account.", "x-ds-method": "getCreditCard", "x-ds-service": "Billing", + "description": "This method returns information about a credit card associated with an account.", "x-ds-in-sdk": true }, "parameters": [] @@ -767,9 +767,9 @@ }, "deprecated": false, "x-ds-methodname": "getDowngradeRequestBillingInfo", - "description": "", "x-ds-method": "getDowngradeRequestBillingInfo", "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "put": { @@ -814,9 +814,9 @@ }, "deprecated": false, "x-ds-methodname": "updateDowngradeAccountBillingPlan", - "description": "", "x-ds-method": "updateDowngradeAccountBillingPlan", "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] @@ -826,7 +826,7 @@ "tags": [ "BillingPlans" ], - "summary": "Reserved: Purchase additional envelopes.", + "summary": "Reserverd: Purchase additional envelopes.", "description": "Reserved: 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.", "operationId": "PurchasedEnvelopes_PutPurchasedEnvelopes", "consumes": [], @@ -1072,9 +1072,9 @@ }, "deprecated": false, "x-ds-methodname": "getBrand", - "description": "This method returns details about an account brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "get", "x-ds-service": "Accounts", + "description": "This method returns details about an account brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "put": { @@ -1100,13 +1100,6 @@ "required": true, "type": "string" }, - { - "name": "replace_brand", - "in": "query", - "required": false, - "type": "string", - "description": "" - }, { "name": "brand", "in": "body", @@ -1133,9 +1126,9 @@ }, "deprecated": false, "x-ds-methodname": "updateBrand", - "description": "This method updates an account brand. \n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "update", "x-ds-service": "Accounts", + "description": "This method updates an account brand. \n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "delete": { @@ -1175,9 +1168,9 @@ }, "deprecated": false, "x-ds-methodname": "deleteBrand", - "description": "This method deletes a brand from an account.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "delete", "x-ds-service": "Accounts", + "description": "This method deletes a brand from an account.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "parameters": [] @@ -1220,9 +1213,9 @@ }, "deprecated": false, "x-ds-methodname": "getBrandExportFile", - "description": "This method exports information about a brand to an XML file.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "getExportFile", "x-ds-service": "Accounts", + "description": "This method exports information about a brand to an XML file.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "parameters": [] @@ -1277,9 +1270,9 @@ }, "deprecated": false, "x-ds-methodname": "getBrandLogoByType", - "description": "This method returns a specific logo that is used in a brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "getLogo", "x-ds-service": "Accounts", + "description": "This method returns a specific logo that is used in a brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "put": { @@ -1338,9 +1331,9 @@ }, "deprecated": false, "x-ds-methodname": "updateBrandLogoByType", - "description": "This method updates a single brand logo.\n\nYou pass in the new version of the resource in the `Content-Disposition` header. Example:\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\"`\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "updateLogo", "x-ds-service": "Accounts", + "description": "This method updates a single brand logo.\n\nYou pass in the new version of the resource in the `Content-Disposition` header. Example:\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\"`\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "delete": { @@ -1387,9 +1380,9 @@ }, "deprecated": false, "x-ds-methodname": "deleteBrandLogoByType", - "description": "This method deletes a single logo from an account brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "deleteLogo", "x-ds-service": "Accounts", + "description": "This method deletes a single logo from an account brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "parameters": [] @@ -1435,9 +1428,9 @@ }, "deprecated": false, "x-ds-methodname": "getBrandResources", - "description": "This method returns metadata about the branding resources that are associated with an account.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "listResources", "x-ds-service": "Accounts", + "description": "This method returns metadata about the branding resources that are associated with an account.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "parameters": [] @@ -1501,9 +1494,9 @@ }, "deprecated": false, "x-ds-methodname": "getBrandResourcesByContentType", - "description": "This method returns a specific branding resource file.\n\nA 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.\n\n**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 your resource files, only the modified elements are included in the file. \n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-method": "getResource", "x-ds-service": "Accounts", + "description": "This method returns a specific branding resource file.\n\nA 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.\n\n**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 your resource files, only the modified elements are included in the file. \n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).", "x-ds-in-sdk": true }, "put": { @@ -1562,9 +1555,9 @@ }, "deprecated": false, "x-ds-methodname": "updateBrandResourcesByContentType", - "description": "This method updates a branding resource file.\n\nYou pass in the new version of the resource file in the `Content-Disposition` header. Example:\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\"`\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\n\n**Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed.\n\nWhen 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 your resource files, only the modified elements are included in the file.", "x-ds-method": "updateResource", "x-ds-service": "Accounts", + "description": "This method updates a branding resource file.\n\nYou pass in the new version of the resource file in the `Content-Disposition` header. Example:\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\"`\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\n\n**Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed.\n\nWhen 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 your resource files, only the modified elements are included in the file.", "x-ds-in-sdk": true }, "parameters": [] @@ -1659,9 +1652,9 @@ }, "deprecated": false, "x-ds-methodname": "getBulkSendBatches", - "description": "Returns a summary of bulk send batches.\n\nUse the `batch_ids` query parameter to narrow the list of batches.", "x-ds-method": "getBulkSendBatches", "x-ds-service": "Uncategorized", + "description": "Returns a summary of bulk send batches.\n\nUse the `batch_ids` query parameter to narrow the list of batches.", "x-ds-in-sdk": true }, "parameters": [] @@ -1707,9 +1700,9 @@ }, "deprecated": false, "x-ds-methodname": "getBulkSendBatchStatus", - "description": "Gets the general status of a specific bulk send batch such as:\n\n- number of successes\n- number pending\n- number of errors\n\nThe `bulkErrors` property of the response object contains more information about the errors.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n", "x-ds-method": "getBulkSendBatchStatus", "x-ds-service": "Uncategorized", + "description": "Gets the general status of a specific bulk send batch such as:\n\n- number of successes\n- number pending\n- number of errors\n\nThe `bulkErrors` property of the response object contains more information about the errors.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n", "x-ds-in-sdk": true }, "put": { @@ -1761,9 +1754,9 @@ }, "deprecated": false, "x-ds-methodname": "updateBulkSendBatchStatus", - "description": "Updates a specific bulk send batch status.", "x-ds-method": "updateBulkSendBatchStatus", "x-ds-service": "Uncategorized", + "description": "Updates a specific bulk send batch status.", "x-ds-in-sdk": true }, "parameters": [] @@ -1825,9 +1818,9 @@ }, "deprecated": false, "x-ds-methodname": "updateBulkSendBatchAction", - "description": "", "x-ds-method": "updateBulkSendBatchAction", "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] @@ -1922,9 +1915,9 @@ }, "deprecated": false, "x-ds-methodname": "getBulkSendBatchEnvelopes", - "description": "This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.", "x-ds-method": "getBulkSendBatchEnvelopes", "x-ds-service": "Uncategorized", + "description": "This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.", "x-ds-in-sdk": true }, "parameters": [] @@ -1963,9 +1956,9 @@ }, "deprecated": false, "x-ds-methodname": "getBulkSendLists", - "description": "This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.", "x-ds-method": "getBulkSendLists", "x-ds-service": "Uncategorized", + "description": "This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.", "x-ds-in-sdk": true }, "post": { @@ -2010,9 +2003,9 @@ }, "deprecated": false, "x-ds-methodname": "createBulkSendList", - "description": "This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n### Errors\n\n| Error code | Description |\n| :------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| BULK_SEND_MAX_COPIES_EXCEEDED | A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000. |\n| BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE | No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list). |\n| BULK_SEND_RECIPIENT_ID_REQUIRED | If no RoleName is present, recipientID is required in mailing list's bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID. |\n| BULK_SEND_RECIPIENT_NAME_REQUIRED | Recipient {0} has no name. Specify a name for the recipient. |\n| BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT | Recipient {0} is an email recipient with no email address. Specify an email for the email recipient. |\n| BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT | Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient. |\n| BULK_SEND_FAX_NUMBER_NOT_VALID | Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient. |\n| BULK_SEND_EMAIL_ADDRESS_NOT_VALID | Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient. |\n| BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH | Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient. |\n| BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH | Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient. |\n| BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE | Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT | Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST | Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list. |\n| BULK_SEND_INVALID_ID_CHECK_CONFIGURATION | Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified. |\n| BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION | Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics. |\n| BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE | Tab label {0} is duplicated. Needs to be unique. Use a unique tab label. |\n| BULK_SEND_TAB_LABEL_REQUIRED | Tab label is required. Specify a tab label. |\n| BULK_SEND_TAB_VALUE_REQUIRED | Tab Label value is required. Specify a value for the tab label. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE | Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED | All custom fields must have names. Specify a name for the custom field. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED | Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field. |", "x-ds-method": "createBulkSendList", "x-ds-service": "Uncategorized", + "description": "This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n### Errors\n\n| Error code | Description |\n| :------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| BULK_SEND_MAX_COPIES_EXCEEDED | A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000. |\n| BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE | No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list). |\n| BULK_SEND_RECIPIENT_ID_REQUIRED | If no RoleName is present, recipientID is required in mailing list's bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID. |\n| BULK_SEND_RECIPIENT_NAME_REQUIRED | Recipient {0} has no name. Specify a name for the recipient. |\n| BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT | Recipient {0} is an email recipient with no email address. Specify an email for the email recipient. |\n| BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT | Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient. |\n| BULK_SEND_FAX_NUMBER_NOT_VALID | Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient. |\n| BULK_SEND_EMAIL_ADDRESS_NOT_VALID | Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient. |\n| BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH | Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient. |\n| BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH | Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient. |\n| BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE | Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT | Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST | Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list. |\n| BULK_SEND_INVALID_ID_CHECK_CONFIGURATION | Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified. |\n| BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION | Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics. |\n| BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE | Tab label {0} is duplicated. Needs to be unique. Use a unique tab label. |\n| BULK_SEND_TAB_LABEL_REQUIRED | Tab label is required. Specify a tab label. |\n| BULK_SEND_TAB_VALUE_REQUIRED | Tab Label value is required. Specify a value for the tab label. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE | Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED | All custom fields must have names. Specify a name for the custom field. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED | Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field. |", "x-ds-in-sdk": true }, "parameters": [] @@ -2058,9 +2051,9 @@ }, "deprecated": false, "x-ds-methodname": "getBulkSendList", - "description": "This method returns all of the details associated with a specific bulk send list that belongs to the current user.", "x-ds-method": "getBulkSendList", "x-ds-service": "Uncategorized", + "description": "This method returns all of the details associated with a specific bulk send list that belongs to the current user.", "x-ds-in-sdk": true }, "put": { @@ -2112,9 +2105,9 @@ }, "deprecated": false, "x-ds-methodname": "updateBulkSendList", - "description": "This method replaces the definition of an existing bulk send list.", "x-ds-method": "updateBulkSendList", "x-ds-service": "Uncategorized", + "description": "This method replaces the definition of an existing bulk send list.", "x-ds-in-sdk": true }, "delete": { @@ -2157,9 +2150,9 @@ }, "deprecated": false, "x-ds-methodname": "deleteBulkSendList", - "description": "This method deletes a bulk send list.", "x-ds-method": "deleteBulkSendList", "x-ds-service": "Uncategorized", + "description": "This method deletes a bulk send list.", "x-ds-in-sdk": true }, "parameters": [] @@ -2214,9 +2207,9 @@ }, "deprecated": false, "x-ds-methodname": "createBulkSendRequest", - "description": "This method initiates the bulk send process. It generates a bulk send request based on an [existing bulk send list][create_list] and an envelope or template.\n\nConsider using the [BulkSend::createBulkSendTestRequest][create_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 overview][BulkSendOverview].\n\nIf the envelopes were successfully queued for asynchronous processing, the response contains a `batchId` that you can use to get the status of the batch. If a failure occurs, the API returns an error message.\n\n**Note:** Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n\n### Errors\n\nThis method returns the following errors:\n\n| Error code | Description |\n| :--------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE | Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as `created`. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES | Cannot send an envelope with a bulk sending list which contains no copies. The list you're trying to bulk send is empty. Make sure the bulk sending list you're using contains recipients. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES | Bulk sending list contains more than {0} copies. The list you're trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists. |\n| BULK_SEND_ENVELOPE_CANNOT_BE_NULL | Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send. |\n| BULK_SEND_BLOB_STORE_ERROR | Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact DocuSign Support. |\n| BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES | Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later.\" .Try again later, or contact DocuSign Support to request a higher tier. |\n| BULK_SEND_ENVELOPE_NOT_FOUND | Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value. |\n| BULK_SEND_LIST_NOT_FOUND | Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value. |\n| BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS | Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE | Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH | Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up. |\n| BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT | Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details. |\n| BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH | Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible. |\n| BULK_SEND_DUPLICATE_RECIPIENT_DETECTED | Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope. |\n| BULK_SEND_ENVELOPE_HAS_NO_TABS | Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending. |\n| BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE | Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_TAB_DOES_NOT_MATCH | Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS | Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE | Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH | Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both. |\n\n[create_list]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/\n[create_test]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendtestrequest/\n[BulkSendOverview]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/\n\n", "x-ds-method": "createBulkSendRequest", "x-ds-service": "Uncategorized", + "description": "This method initiates the bulk send process. It generates a bulk send request based on an [existing bulk send list][create_list] and an envelope or template.\n\nConsider using the [BulkSend::createBulkSendTestRequest][create_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 overview][BulkSendOverview].\n\nIf the envelopes were successfully queued for asynchronous processing, the response contains a `batchId` that you can use to get the status of the batch. If a failure occurs, the API returns an error message.\n\n**Note:** Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n\n### Errors\n\nThis method returns the following errors:\n\n| Error code | Description |\n| :--------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE | Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as `created`. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES | Cannot send an envelope with a bulk sending list which contains no copies. The list you're trying to bulk send is empty. Make sure the bulk sending list you're using contains recipients. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES | Bulk sending list contains more than {0} copies. The list you're trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists. |\n| BULK_SEND_ENVELOPE_CANNOT_BE_NULL | Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send. |\n| BULK_SEND_BLOB_STORE_ERROR | Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact DocuSign Support. |\n| BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES | Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later.\" .Try again later, or contact DocuSign Support to request a higher tier. |\n| BULK_SEND_ENVELOPE_NOT_FOUND | Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value. |\n| BULK_SEND_LIST_NOT_FOUND | Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value. |\n| BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS | Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE | Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH | Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up. |\n| BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT | Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details. |\n| BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH | Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible. |\n| BULK_SEND_DUPLICATE_RECIPIENT_DETECTED | Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope. |\n| BULK_SEND_ENVELOPE_HAS_NO_TABS | Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending. |\n| BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE | Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_TAB_DOES_NOT_MATCH | Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS | Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE | Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH | Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both. |\n\n[create_list]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/\n[create_test]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendtestrequest/\n[BulkSendOverview]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/\n\n", "x-ds-in-sdk": true }, "parameters": [] @@ -2271,9 +2264,9 @@ }, "deprecated": false, "x-ds-methodname": "createBulkSendTestRequest", - "description": "This 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.\n\nA successful test result returns `true` for the `canBeSent` property. An unsuccessful test returns a JSON response that contains information about the errors that occurred.\n\nIf the test is successful, you can then send the envelope or template by using the [BulkSend::createBulkSendRequest][BulkSendRequest] method.\n\n## Envelope Compatibility Checks\n\nThis section describes the envelope compatibility checks that the system performs.\n\n**Top-Level Issues**\n\n- Envelopes must be in a sendable state.\n- The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.\n- The envelope must not be null and must be visible to the current user.\n- The account cannot have more queued envelopes than the maximum number configured for the account.\n- The bulk send list must exist.\n\n**Recipients**\n\n- The envelope must have recipients.\n- If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.\n- The envelope cannot contain a bulk recipient (an artifact of the legacy version of DocuSign's bulk send\n functionality).\n\n**Recipient Tabs**\n\n- Every `recipient ID, tab label` pair in the bulk send list must correspond to a tab in the envelope.\n\n**Custom Fields**\n\n- Each envelope-level custom field in the bulk send list must correspond to the name of a `customField` in the\n envelope definition. You do not have to match the recipient-level custom fields.\n\n[BulkSendRequest]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/\n\n\n", "x-ds-method": "createBulkSendTestRequest", "x-ds-service": "Uncategorized", + "description": "This 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.\n\nA successful test result returns `true` for the `canBeSent` property. An unsuccessful test returns a JSON response that contains information about the errors that occurred.\n\nIf the test is successful, you can then send the envelope or template by using the [BulkSend::createBulkSendRequest][BulkSendRequest] method.\n\n## Envelope Compatibility Checks\n\nThis section describes the envelope compatibility checks that the system performs.\n\n**Top-Level Issues**\n\n- Envelopes must be in a sendable state.\n- The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.\n- The envelope must not be null and must be visible to the current user.\n- The account cannot have more queued envelopes than the maximum number configured for the account.\n- The bulk send list must exist.\n\n**Recipients**\n\n- The envelope must have recipients.\n- If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.\n- The envelope cannot contain a bulk recipient (an artifact of the legacy version of DocuSign's bulk send\n functionality).\n\n**Recipient Tabs**\n\n- Every `recipient ID, tab label` pair in the bulk send list must correspond to a tab in the envelope.\n\n**Custom Fields**\n\n- Each envelope-level custom field in the bulk send list must correspond to the name of a `customField` in the\n envelope definition. You do not have to match the recipient-level custom fields.\n\n[BulkSendRequest]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/\n\n\n", "x-ds-in-sdk": true }, "parameters": [] @@ -2379,9 +2372,9 @@ "deprecated": false, "x-ds-methodname": "createChunkedUpload", "x-ds-api-status": "beta", - "description": "This method initiates a new chunked upload with the first part of the content.", "x-ds-method": "create", "x-ds-service": "Envelopes", + "description": "This method initiates a new chunked upload with the first part of the content.", "x-ds-in-sdk": true }, "parameters": [] @@ -2435,9 +2428,9 @@ "deprecated": false, "x-ds-methodname": "getChunkedUpload", "x-ds-api-status": "beta", - "description": "Returns the details (but not the content) about a chunked upload.\n\n**Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.", "x-ds-method": "get", "x-ds-service": "Envelopes", + "description": "Returns the details (but not the content) about a chunked upload.\n\n**Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.", "x-ds-in-sdk": true }, "put": { @@ -2488,9 +2481,9 @@ "deprecated": false, "x-ds-methodname": "updateChunkedUpload", "x-ds-api-status": "beta", - "description": "This 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.\n\nIf the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.\n\n**Note:** After you commit a chunked upload, it no longer accepts additional parts.", "x-ds-method": "commit", "x-ds-service": "Envelopes", + "description": "This 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.\n\nIf the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.\n\n**Note:** After you commit a chunked upload, it no longer accepts additional parts.", "x-ds-in-sdk": true }, "delete": { @@ -2534,9 +2527,9 @@ "deprecated": false, "x-ds-methodname": "deleteChunkedUpload", "x-ds-api-status": "beta", - "description": "Deletes a chunked upload that has been committed but not yet consumed.\n\nThis method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:\n\n\n- Chunked uploads that have been consumed by use in another API call.\n- Expired chunked uploads.\n\n**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 continue to count against your quota.", "x-ds-method": "delete", "x-ds-service": "Envelopes", + "description": "Deletes a chunked upload that has been committed but not yet consumed.\n\nThis method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:\n\n\n- Chunked uploads that have been consumed by use in another API call.\n- Expired chunked uploads.\n\n**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 continue to count against your quota.", "x-ds-in-sdk": true }, "parameters": [] @@ -2599,9 +2592,9 @@ "deprecated": false, "x-ds-methodname": "updateChunkedUploadPart", "x-ds-api-status": "beta", - "description": "Adds 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, \nuse this method to upload subsequent parts.\n\nFor 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 parts contiguously until you have uploaded the entirety of the original content to DocuSign.\n\nExample:\n\n\n```\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3\n```\n\n**Note:** You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.", "x-ds-method": "update", "x-ds-service": "Envelopes", + "description": "Adds 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, \nuse this method to upload subsequent parts.\n\nFor 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 parts contiguously until you have uploaded the entirety of the original content to DocuSign.\n\nExample:\n\n\n```\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3\n```\n\n**Note:** You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.", "x-ds-in-sdk": true }, "parameters": [] @@ -2612,7 +2605,7 @@ "ConnectConfigurations" ], "summary": "Get Connect configuration information.", - "description": "Retrieves all the DocuSign Custom Connect definitions for the specified account.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Retrieves all the DocuSign Custom Connect definitions for the specified account.\n\n**Note:** Connect must be enabled for your account to use this function.", "operationId": "Connect_GetConnectConfigs", "consumes": [], "produces": [], @@ -2650,7 +2643,7 @@ "ConnectConfigurations" ], "summary": "Updates a specified Connect configuration.", - "description": "Updates the specified DocuSign Connect configuration in your account. To enable the configuration, set the `allowEnvelopePublish` property to **true.**\n\nAfter any updates, test your configuration to make sure it works as expected.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Updates the specified DocuSign Connect configuration in your account. To enable the configuration, set the `allowEnvelopePublish` property to **true.**\n\n**Note:** Connect must be enabled for your account to use this function.", "operationId": "Connect_PutConnectConfiguration", "consumes": [], "produces": [], @@ -2697,7 +2690,7 @@ "ConnectConfigurations" ], "summary": "Creates a Connect configuration.", - "description": "Creates a custom Connect configuration for the specified account.\n\nConnect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create:\n* Account-level Connect configurations to listen for events related to any envelopes sent by one or more account users\n* Recipient Connect configurations that are triggered when one or more of your account users receive an envelope\n\nTo set an account-level configuration, set `configurationType` to **custom.**\nTo set a Recipient Connect configuration, set `configurationType` to **customrecipient.**\n\nIf you want to listen for events on only one envelope, use the [eventNotification](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_eventnotification) object instead.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n## Data models\n\nThere are four possible data models for your Connect configuration. Consider:\n* Do you want the data in JSON or XML?\n* Do you want events sent individually (SIM) or in aggregate?\n\nDocuSign recommends using the [JSON SIM event model](/platform/webhooks/connect/improved-json-sim-event-model/).\n\n\n\n\n

JSON SIM (Recommended)

\n
\n\nSet `deliveryMode` to **SIM** and `eventData.version` to **restv2.1.** Use the `events` property to set the event statuses that will trigger your configuration.\n\nThe following sample request shows how to create an envelope-level configuration using JSON SIM:\n```\n{\n \"configurationType\": \"custom\",\n \"urlToPublishTo\": \"YOUR-WEBHOOK-URL\",\n \"allUsers\": \"true\",\n \"name\": \"jsonSimTest\",\n \"deliveryMode\": \"SIM\",\n \"allowEnvelopePublish\": \"true\",\n \"enableLog\": \"true\",\n \"eventData\": {\n \"version\": \"restv2.1\"\n },\n \"events\": [\n \"envelope-sent\",\n \"envelope-delivered\",\n \"envelope-completed\"\n ]\n}\n```\n\nThe following sample request shows how to create a Recipient Connect configuration using JSON SIM:\n```\n{\n \"configurationType\": \"customrecipient\",\n \"urlToPublishTo\": \"YOUR-WEBHOOK-URL\",\n \"allUsers\": \"true\",\n \"name\": \"jsonSimTest\",\n \"deliveryMode\": \"SIM\",\n \"allowEnvelopePublish\": \"true\",\n \"enableLog\": \"true\",\n \"eventData\": {\n \"version\": \"restv2.1\"\n },\n \"events\": [\n \"recipient-sent\",\n \"recipient-completed\"\n ]\n}\n```\n\n
\n\n\n

JSON Aggregate

\n
\n\nSet `deliveryMode` to **aggregate** and `eventData.version` to **restv2.1.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n
\n\n\n

XML Aggregate

\n
\n\nSet `deliveryMode` to **aggregate.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n
\n\n\n

XML SIM (Legacy apps only)

\n
\n\n**Note:** This model [will be deprecated](https://www.docusign.com/blog/developers/docusign-connect-xml-sim-messaging-format-deprecated). \n\nSet `deliveryMode` to **SIM.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n
\n\n\n## Troubleshooting\n\nIf your configuration is not working, check the following.\n\n* Connect must be enabled for your account to use this function.\n* If you are using `envelopeEvents` or `recipientEvents`, make sure that the event values are sentence case, not lowercase.\n* Make sure you have either set `allUsers` to **true** or set `userIds` to a non-empty array of IDs.\n* By default, this endpoint creates a disabled configuration. To enable the configuration immediately, set the body parameter `allowEnvelopePublish` to **true.** You can also enable the configuration in the UI.\n* To check if events are being emitted, set `enableLog` to **true** to view event logs in the Connect console.\n\n## Related topics\n\n* For more information about Connect, see the [DocuSign Connect guide](/platform/webhooks/connect/).\n* Use the MyAPICalls sample app to see an [example of this endpoint](https://myapicalls.sampleapps.docusign.com/scenario/6) using the JSON SIM model.", + "description": "Creates a custom Connect configuration for the specified account. Connect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create:\n* Account-level Connect configurations to listen for events related to any envelopes you've sent\n* Recipient Connect configurations that are triggered when one or more of your account users receive an envelope\n\nIf you want to listen for events on only one envelope, use the [eventNotification](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_eventnotification) object instead.\n\nBy default, this endpoint creates a disabled configuration. To enable the configuration immediately, set the body parameter `allowEnvelopePublish` to **true.**\n\n**Note:** Connect must be enabled for your account to use this function.\n\n### Related topics\n\n* For more information about Connect, see the [DocuSign Connect guide](/platform/webhooks/connect/).", "operationId": "Connect_PostConnectConfiguration", "consumes": [], "produces": [], @@ -2747,7 +2740,7 @@ "ConnectConfigurations" ], "summary": "Gets the details about a Connect configuration.", - "description": "Retrieves the information for the specified DocuSign Connect configuration.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n", + "description": "Retrieves the information for the specified DocuSign Connect configuration.\n\n**Note:** Connect must be enabled for your account to use this function.\n", "operationId": "Connect_GetConnectConfig", "consumes": [], "produces": [], @@ -2792,7 +2785,7 @@ "ConnectConfigurations" ], "summary": "Deletes the specified Connect configuration.", - "description": "Deletes the specified DocuSign Connect configuration.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n\n", + "description": "Deletes the specified DocuSign Connect configuration.\n\n**Note:** Connect must be enabled for your account to use this function.\n\n\n", "operationId": "Connect_DeleteConnectConfig", "consumes": [], "produces": [], @@ -2914,9 +2907,9 @@ }, "deprecated": false, "x-ds-methodname": "getConnectAllUsers", - "description": "Returns all users from the configured Connect service.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", "x-ds-method": "getConnectAllUsers", "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] @@ -2927,7 +2920,7 @@ "ConnectConfigurations" ], "summary": "Returns users from the configured Connect service.", - "description": "Returns users from the configured Connect service.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Returns users from the configured Connect service.", "operationId": "Connect_GetConnectUsers", "consumes": [], "produces": [], @@ -3017,7 +3010,7 @@ "ConnectEvents" ], "summary": "Republishes Connect information for the specified envelope.", - "description": "Republishes Connect information for the specified envelope.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Republishes Connect information for the specified envelope.", "operationId": "ConnectPublish_PutConnectRetryByEnvelope", "consumes": [], "produces": [], @@ -3059,63 +3052,13 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/connect/envelopes/publish/historical": { - "post": { - "tags": [ - "EnvelopePublish" - ], - "summary": "Submits a batch of historical envelopes for republish to a webhook.", - "operationId": "HistoricalEnvelopePublish_PostHistoricalEnvelopePublishTransaction", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "connectHistoricalEnvelopeRepublish", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/connectHistoricalEnvelopeRepublish" - }, - "description": "" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/envelopePublishTransaction" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "createHistoricalEnvelopePublishTransaction", - "x-ds-method": "createHistoricalEnvelopePublishTransaction", - "x-ds-service": "Uncategorized", - "description": "This endpoint submits a batch of existing envelopes to a webhook of your choice. Set the webhook address with the `urlToPublishTo` request body parameter.\n\nThis 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.\n\nIf the request succeeds, it returns a 201 (Created) HTTP response code and the response body property `processingStatus` will be set to `processing`. You can then view the status of each historical republish request in the [Bulk Actions Log](https://support.docusign.com/s/document-item?language=en_US&bundleId=pik1583277475390&topicId=nvf1648497452396.html&_LANG=enus).\n\n**Note:** The envelope data will always be transmitted in JSON format. XML, Salesforce, and eOriginal configuration types are not supported.", - "x-ds-in-sdk": true - }, - "parameters": [] - }, "/v2.1/accounts/{accountId}/connect/envelopes/retry_queue": { "put": { "tags": [ "ConnectEvents" ], "summary": "Republishes Connect information for multiple envelopes.", - "description": "Republishes Connect information for the specified set of envelopes. 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/connectevents/list/) retrieve the failure log.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Republishes Connect information for the specified set of envelopes. 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/connectevents/list/) retrieve the failure log.\n", "operationId": "ConnectPublish_PutConnectRetry", "consumes": [], "produces": [], @@ -3165,7 +3108,7 @@ "ConnectEvents" ], "summary": "Gets the Connect failure log information.", - "description": "Retrieves the Connect failure log information. You can use this log to determine which envelopes failed to post, in order to create a republish request.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Retrieves the Connect failure log information. You can use this log to determine which envelopes failed to post, in order to create a republish request.", "operationId": "ConnectFailures_GetConnectLogs", "consumes": [], "produces": [], @@ -3220,7 +3163,7 @@ "ConnectEvents" ], "summary": "Deletes a Connect failure log entry.", - "description": "Deletes the Connect failure log information for the specified entry.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Deletes the Connect failure log information for the specified entry.", "operationId": "ConnectFailures_DeleteConnectFailureLog", "consumes": [], "produces": [], @@ -3268,7 +3211,7 @@ "ConnectEvents" ], "summary": "Gets the Connect log.", - "description": "Retrieves a list of the 100 most recent connect log entries for your account.\n\nThe `enableLog` setting in the Connect configuration must be set to **true** to enable logging.\nIf logging is not enabled, then no log entries are recorded.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Retrieves a list of connect log entries for your account.\n\n**Note:** 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.", "operationId": "ConnectLog_GetConnectLogs", "consumes": [], "produces": [], @@ -3320,7 +3263,7 @@ "ConnectEvents" ], "summary": "Deletes a list of Connect log entries.", - "description": "Deletes a list of Connect log entries for your account.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Deletes a list of Connect log entries for your account.", "operationId": "ConnectLog_DeleteConnectLogs", "consumes": [], "produces": [], @@ -3358,7 +3301,7 @@ "ConnectEvents" ], "summary": "Gets a Connect log entry.", - "description": "Retrieves the specified Connect log entry for your account.\n\nThe `enableLog` setting in the Connect configuration must be set to **true** to enable logging.\nIf logging is not enabled, then no log entries are recorded.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Retrieves the specified Connect log entry for your account.\n\n**Note:** 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.", "operationId": "ConnectLog_GetConnectLog", "consumes": [], "produces": [], @@ -3410,7 +3353,7 @@ "ConnectEvents" ], "summary": "Deletes a specified Connect log entry.", - "description": "Deletes a specified entry from the Connect Log.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", + "description": "Deletes a specified entry from the Connect Log.\n", "operationId": "ConnectLog_DeleteConnectLog", "consumes": [], "produces": [], @@ -3449,129 +3392,6 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/connect/oauth": { - "get": { - "tags": [ - "ConnectConfigurations" - ], - "summary": "Sets the Connect OAuth Config for the account.", - "operationId": "ConnectOAuthConfig_GetConnectOAuthConfig", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/connectOAuthConfig" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "getConnectOAuthConfig", - "x-ds-method": "getConnectOAuthConfig", - "x-ds-service": "Uncategorized", - "description": "", - "x-ds-in-sdk": true - }, - "post": { - "tags": [ - "ConnectConfigurations" - ], - "summary": "Sets the Connect OAuth Config for the account.", - "operationId": "ConnectOAuthConfig_PostConnectOAuthConfig", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "connectOAuthConfig", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/connectOAuthConfig" - }, - "description": "" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/connectOAuthConfig" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "createConnectOAuthConfig", - "x-ds-method": "createConnectOAuthConfig", - "x-ds-service": "Uncategorized", - "description": "", - "x-ds-in-sdk": true - }, - "delete": { - "tags": [ - "ConnectConfigurations" - ], - "summary": "Sets the Connect OAuth Config for the account.", - "operationId": "ConnectOAuthConfig_DeleteConnectOAuthConfig", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successful response." - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "deleteConnectOAuthConfig", - "x-ds-method": "deleteConnectOAuthConfig", - "x-ds-service": "Uncategorized", - "description": "", - "x-ds-in-sdk": true - }, - "parameters": [] - }, "/v2.1/accounts/{accountId}/consumer_disclosure": { "get": { "tags": [ @@ -3722,9 +3542,9 @@ }, "deprecated": false, "x-ds-methodname": "updateConsumerDisclosure", - "description": "Account administrators can use this method to perform the following tasks:\n\n- Customize values in the default disclosure.\n- Switch to a custom disclosure that uses your own text and HTML formatting.\n- Change values in your existing consumer disclosure. \n\nTo specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter.\n\n**Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. \n\n## Updating the default disclosure\n\nWhen you update the default disclosure, you can edit all properties except for the following ones:\n\n- `accountEsignId`: This property is read-only.\n- `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure.\n- `esignAgreement`: This property is read-only.\n- `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`.\n- Metadata properties: These properties are read-only.\n\n**Note:** The text of the default disclosure is always in English.\n\n## Switching to a custom disclosure\n\nTo switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. \n\nYou can also edit all of the other properties except for the following ones:\n\n- `accountEsignId`: This property is read-only.\n- `esignAgreement`: This property is read-only.\n- Metadata properties: These properties are read-only.\n\n**Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating.\n\n**Important:** When you switch from a default to a custom disclosure, note the following information:\n\n- You will not be able to return to using the default disclosure.\n- Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n## Updating a custom disclosure\n\nWhen you update a custom disclosure, you can update all of the properties except for the following ones:\n\n- `accountEsignId`: This property is read-only. \n- `esignAgreement`: This property is read-only.\n- Metadata properties: These properties are read-only.\n\n**Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n", "x-ds-method": "update", "x-ds-service": "Accounts", + "description": "Account administrators can use this method to perform the following tasks:\n\n- Customize values in the default disclosure.\n- Switch to a custom disclosure that uses your own text and HTML formatting.\n- Change values in your existing consumer disclosure. \n\nTo specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter.\n\n**Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. \n\n## Updating the default disclosure\n\nWhen you update the default disclosure, you can edit all properties except for the following ones:\n\n- `accountEsignId`: This property is read-only.\n- `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure.\n- `esignAgreement`: This property is read-only.\n- `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`.\n- Metadata properties: These properties are read-only.\n\n**Note:** The text of the default disclosure is always in English.\n\n## Switching to a custom disclosure\n\nTo switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. \n\nYou can also edit all of the other properties except for the following ones:\n\n- `accountEsignId`: This property is read-only.\n- `esignAgreement`: This property is read-only.\n- Metadata properties: These properties are read-only.\n\n**Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating.\n\n**Important:** When you switch from a default to a custom disclosure, note the following information:\n\n- You will not be able to return to using the default disclosure.\n- Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n## Updating a custom disclosure\n\nWhen you update a custom disclosure, you can update all of the properties except for the following ones:\n\n- `accountEsignId`: This property is read-only. \n- `esignAgreement`: This property is read-only.\n- Metadata properties: These properties are read-only.\n\n**Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n", "x-ds-in-sdk": true }, "parameters": [] @@ -3772,9 +3592,9 @@ }, "deprecated": false, "x-ds-methodname": "putContacts", - "description": "This method updates one or more contacts associated with an account.", "x-ds-method": "update", "x-ds-service": "Users", + "description": "This method updates one or more contacts associated with an account.", "x-ds-in-sdk": true }, "post": { @@ -3819,9 +3639,9 @@ }, "deprecated": false, "x-ds-methodname": "postContacts", - "description": "This method adds multiple contacts into a contacts list.", "x-ds-method": "create", "x-ds-service": "Users", + "description": "This method adds multiple contacts into a contacts list.", "x-ds-in-sdk": true }, "delete": { @@ -3866,9 +3686,9 @@ }, "deprecated": false, "x-ds-methodname": "deleteContacts", - "description": "This method deletes multiple contacts associated with an account.", "x-ds-method": "deleteList", "x-ds-service": "Users", + "description": "This method deletes multiple contacts associated with an account.", "x-ds-in-sdk": true }, "parameters": [] @@ -3921,9 +3741,9 @@ }, "deprecated": false, "x-ds-methodname": "getContactById", - "description": "This method returns one or more contacts\nassociated with a DocuSign account. You can also\nretrieve contacts from connected [cloud storage][CloudStorage] providers by using the\n`cloud_provider` query parameter. By default,\ncontacts are retrieved from the DocuSign account's\ndefault address book.\n\nTo return a specific contact, use the `contactId`\nquery parameter. To return all contacts associated\nwith an account, omit this parameter.\n\n[CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/", "x-ds-method": "get", "x-ds-service": "Users", + "description": "This method returns one or more contacts\nassociated with a DocuSign account. You can also\nretrieve contacts from connected [cloud storage][CloudStorage] providers by using the\n`cloud_provider` query parameter. By default,\ncontacts are retrieved from the DocuSign account's\ndefault address book.\n\nTo return a specific contact, use the `contactId`\nquery parameter. To return all contacts associated\nwith an account, omit this parameter.\n\n[CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/", "x-ds-in-sdk": true }, "delete": { @@ -3966,9 +3786,9 @@ }, "deprecated": false, "x-ds-methodname": "deleteContactWithId", - "description": "This method deletes a contact associated with an account.", "x-ds-method": "delete", "x-ds-service": "Users", + "description": "This method deletes a contact associated with an account.", "x-ds-in-sdk": true }, "parameters": [] @@ -4061,9 +3881,9 @@ }, "deprecated": false, "x-ds-methodname": "createCustomField", - "description": "This method creates a custom field and makes it available for all new envelopes associated with an account.", "x-ds-method": "create", "x-ds-service": "Accounts", + "description": "This method creates a custom field and makes it available for all new envelopes associated with an account.", "x-ds-in-sdk": true }, "parameters": [] @@ -4125,9 +3945,9 @@ }, "deprecated": false, "x-ds-methodname": "updateCustomField", - "description": "This method updates an existing account custom field.", "x-ds-method": "update", "x-ds-service": "Accounts", + "description": "This method updates an existing account custom field.", "x-ds-in-sdk": true }, "delete": { @@ -4174,9 +3994,9 @@ }, "deprecated": false, "x-ds-methodname": "deleteCustomField", - "description": "This method deletes an existing account custom field.", "x-ds-method": "delete", "x-ds-service": "Accounts", + "description": "This method deletes an existing account custom field.", "x-ds-in-sdk": true }, "parameters": [] @@ -4186,8 +4006,8 @@ "tags": [ "Envelopes" ], - "summary": "Search for specific sets of envelopes by using search filters.", - "description": "This method lets you\n[search for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/)\nin your accounts.\nA large set of filters let you narrow the scope of your search\nby date,\nby envelope ID,\nor by status codes.\nYour request must include one or more of the following parameters:\n\n* `from_date`\n* `envelope_ids`\n* `transaction_ids`\n\n\nTo avoid unnecessary database queries, the DocuSign\nsignature platform first checks requests to ensure that the\nfilter set supplied does not result in a zero-size response\nbefore querying the database.\n\nFor example, for a request with a `from_to_status` of\n`delivered` and a current `status` of `created,sent`,\nDocuSign will always return an empty list.\nThis is because the request translates to: find the\nenvelopes that were delivered between the `from_date` and\n`to_date` dates that have a current status of `created` or\n`sent`. Since an envelope that has been delivered can\nnever have a status of `created` or `sent`, a zero-size\nresponse would be generated.\nIn this case, DocuSign does not query the database\nand returns an empty list immediately.\n\nGetting envelope status using `transaction_ids` is useful\nfor offline signing situations where it can be used\ndetermine if an envelope was created or not. It can be used\nfor the cases where a network connection was lost, before\nthe envelope status could be returned.\n\n\nThe following table shows the valid current envelope\nstatuses (`status` parameter) for the different status\nqualifiers (`from_to_status` parameter) in the request. If\nthe status and status qualifiers in the API request do not\ncontain any of the values shown in the Valid Current\nStatuses column, then an empty list is returned.\n\nClient applications should check that the statuses (`status`\nparameter) they are requesting make sense for a given\n`from_to_status` parameter value.\n\n| Status Qualifier
(`from_to_status`) | Effective Status Qualifier | Valid Current Statuses |\n| :------------------------------------- | :------------------------- | :-------------------------------------------------------------------------- |\n| any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted |\n| created | Created | any, created, sent, delivered, signed, completed, declined, voided, deleted |\n| sent | Sent | any, sent, delivered, signed, completed, declined, voided, deleted |\n| delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted |\n| signed | StatusChanged | any, signed, completed, declined, voided, deleted |\n| completed | Completed | any, completed, declined, voided, deleted |\n| declined | StatusChanged | any, declined, voided, deleted |\n| timedout
always return zero results | StatusChanged | any, voided, deleted |\n| voided | Voided | any, voided, deleted |\n| deleted | StatusChanged | any, deleted |\n\n## Extraneous results\n\nIn some cases, a request for a specific envelope status will\ninclude envelopes with additional statuses. For example, in\na request with a `from_date` of 2017-01-01, a `to_date` of\n2017-01-07 and the status qualifier (`from_to_status`) set\nto `delivered`, the response set might contain envelopes\nthat were created during that time period, but not delivered\nduring the time period. As a workaround, check the envelope\nstatus values in the result set as needed.\n\n\n### Related topics\n\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)\n", + "summary": "Gets status changes for one or more envelopes.", + "description": "Retrieves a list of envelopes that match your request. \nA large set of optional filters let you filter\nby date,\nby envelope ID,\nor by status codes.\n\nYour request must include one or more of the following parameters:\n\n* `from_date`\n* `envelope_ids`\n* `transaction_ids`\n\n\nGetting envelope status using `transaction_ids` is useful\nfor offline signing situations where it can be used\ndetermine if an envelope was created or not. It can be used\nfor the cases where a network connection was lost, before\nthe envelope status could be returned.\n\nTo avoid unnecessary database queries, the DocuSign\nsignature platform first checks requests to ensure that the\nfilter set supplied does not result in a zero-size response\nbefore querying the database.\n\nFor example, for a request with a `from_to_status` of\n`delivered` and a current `status` of `created,sent`,\nDocuSign will always return an empty list.\nThis is because the request translates to: find the\nenvelopes that were delivered between the `from_date` and\n`to_date` dates that have a current status of `created` or\n`sent`. Since an envelope that has been delivered can\nnever have a status of `created` or `sent`, a zero-size\nresponse would be generated.\nIn this case, DocuSign does not query the database\nand returns an empty list immediately.\n\n\nThe following table shows the valid current envelope\nstatuses (`status` parameter) for the different status\nqualifiers (`from_to_status` parameter) in the request. If\nthe status and status qualifiers in the API request do not\ncontain any of the values shown in the Valid Current\nStatuses column, then an empty list is returned.\n\nClient applications should check that the statuses (`status`\nparameter) they are requesting make sense for a given\n`from_to_status` parameter value.\n\n| Status Qualifier
(`from_to_status`) | Effective Status Qualifier | Valid Current Statuses |\n| :------------------------------------- | :------------------------- | :-------------------------------------------------------------------------- |\n| any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted |\n| created | Created | any, created, sent, delivered, signed, completed, declined, voided, deleted |\n| sent | Sent | any, sent, delivered, signed, completed, declined, voided, deleted |\n| delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted |\n| signed | StatusChanged | any, signed, completed, declined, voided, deleted |\n| completed | Completed | any, completed, declined, voided, deleted |\n| declined | StatusChanged | any, declined, voided, deleted |\n| timedout
always return zero results | StatusChanged | any, voided, deleted |\n| voided | Voided | any, voided, deleted |\n| deleted | StatusChanged | any, deleted |\n\n## Extraneous results\n\nIn some cases, a request for a specific envelope status will\ninclude envelopes with additional statuses. For example, in\na request with a `from_date` of 2017-01-01, a `to_date` of\n2017-01-07 and the status qualifier (`from_to_status`) set\nto `delivered`, the response set might contain envelopes\nthat were created during that time period, but not delivered\nduring the time period. As a workaround, check the envelope\nstatus values in the result set as needed.\n\n\n### Related topics\n\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)\n", "operationId": "Envelopes_GetEnvelopes", "consumes": [], "produces": [], @@ -5091,9 +4911,9 @@ "deprecated": false, "x-ds-methodname": "getAttachments", "x-ds-api-status": "beta", - "description": "Returns a list of attachments associated with a specified envelope.", "x-ds-method": "list", "x-ds-service": "Envelopes", + "description": "Returns a list of attachments associated with a specified envelope", "x-ds-in-sdk": true }, "put": { @@ -5146,9 +4966,9 @@ "deprecated": false, "x-ds-methodname": "putAttachments", "x-ds-api-status": "beta", - "description": "Adds one or more attachments to a draft or in-process envelope.\n\nEnvelope 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.\n\nFor a list of supported file formats, see [Supported File Formats](https://support.docusign.com/guides/ndse-user-guide-supported-file-formats).", "x-ds-method": "create", "x-ds-service": "Envelopes", + "description": "Adds one or more attachments to a draft or in-process envelope.\n\nEnvelope 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.\n\nFor a list of supported file formats, see [Supported File Formats](https://support.docusign.com/guides/ndse-user-guide-supported-file-formats).", "x-ds-in-sdk": true }, "delete": { @@ -5201,9 +5021,9 @@ "deprecated": false, "x-ds-methodname": "deleteAttachments", "x-ds-api-status": "beta", - "description": "Deletes one or more attachments from a draft envelope.", "x-ds-method": "delete", "x-ds-service": "Envelopes", + "description": "Deletes one or more attachments from a draft envelope.", "x-ds-in-sdk": true }, "parameters": [] @@ -5254,9 +5074,9 @@ "deprecated": false, "x-ds-methodname": "getAttachment", "x-ds-api-status": "beta", - "description": "Retrieves an attachment from an envelope.", "x-ds-method": "get", "x-ds-service": "Envelopes", + "description": "Retrieves an attachment from an envelope.", "x-ds-in-sdk": true }, "put": { @@ -5316,9 +5136,9 @@ "deprecated": false, "x-ds-methodname": "putAttachment", "x-ds-api-status": "beta", - "description": "Adds an attachment to a draft or in-process envelope.", "x-ds-method": "update", "x-ds-service": "Envelopes", + "description": "Adds an attachment to a draft or in-process envelope.", "x-ds-in-sdk": true }, "parameters": [] @@ -5421,9 +5241,9 @@ }, "deprecated": false, "x-ds-methodname": "getCommentsTranscript", - "description": "Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.\n\nThe response body of this method is the PDF file as a byte\nstream.\n\n\n**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**). ", "x-ds-method": "get", "x-ds-service": "Uncategorized", + "description": "Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.\n\nThe response body of this method is the PDF file as a byte\nstream.\n\n\n**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**). ", "x-ds-in-sdk": true }, "parameters": [] @@ -5917,8 +5737,8 @@ "tags": [ "EnvelopeDocuments" ], - "summary": "Retrieves a single document or all documents from an envelope.", - "description": "Retrieves a single document or all documents from an envelope.\n\nTo retrieve a single document, provide the ID of the document in the `documentId` path parameter.\nAlternatively, by setting the `documentId` parameter to special keyword values,\nyou can retrieve all the documents (as a combined PDF, portfolio PDF, or ZIP archive)\nor just the certificate of completion. See the `documentId` description for how to retrieve each format.\n\n\nThe response body of this method\nis a file. If you request multiple documents,\nthe result is a ZIP archive\nthat contains all of the documents.\n\nIn all other cases, the response is a PDF\nfile or PDF portfolio.\n\n\nYou can get the file name and document ID from the response's `Content-Disposition` header:\n\n```\nContent-Disposition: file; filename=\"NDA.pdf\"; documentid=\"1\n```\n\nBy default, the response is the PDF file\nas a byte stream.\nFor example a request/response in `curl` looks like this:\n\n```\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\n --header 'Authorization: Bearer eyJ...bqg'\n\n\nHTTP/1.1 200 OK\nContent-Length: 167539\nContent-Type: application/pdf\n. . .\nContent-Disposition: file; filename=\"Lorem_Ipsum.pdf\"; documentid=\"1\"\nDate: Tue, 23 Aug 2022 01:13:15 GMT\n\n%PDF-1.4\n%˚¸˝˛\n6 0 obj\n<>stream\n. . .\n```\n\nBy using the `Content-Transfer-Encoding`\nheader in the request, you can obtain the PDF file\nencoded in base64. The same `curl` request with\nthe base64 header would look like this:\n\n```\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\n --header 'Authorization: Bearer eyJ...bqg' \\\n --header 'Content-Transfer-Encoding: base64'\n\n\nHTTP/1.1 200 OK\nContent-Length: 223384\nContent-Type: application/pdf\n. . .\nContent-Disposition: file; filename=\"Lorem_Ipsum.pdf\"; documentid=\"1\"\nContent-Transfer-Encoding: base64\nDate: Tue, 23 Aug 2022 01:12:30 GMT\n\nJVBERi0xLjQKJfv8/f4KNiAwIG9iago8PC9MZW. . .==\n```\n\n\n(In an actual `curl` request you would use the `--output` switch to\nsave the byte stream into a file.)\n\n### Related topics\n\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\n", + "summary": "Gets a document from an envelope.", + "description": "Retrieves the specified document from the envelope. If the\naccount has the **Highlight Data Changes** feature enabled,\nset the `show_changes` query parameter to **true** highlight the changes. \n\n\nThe response body of this method is the PDF file as a byte\nstream. You can get the file name and document ID\nfrom the response's\n`Content-Disposition` header:\n\n```\nContent-Disposition: file; filename=\"NDA.pdf\"; documentid=\"1\n```\n\nFor example a request/response in `curl` looks like this:\n\n```\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\n --header 'Authorization: Bearer eyJ...bqg'\n\n\nHTTP/1.1 200 OK\nCache-Control: no-cache\nContent-Length: 282143\nContent-Type: application/pdf\nX-RateLimit-Reset: 1320855230\nX-RateLimit-Remaining: 984\nX-RateLimit-Limit: 1000\nX-BurstLimit-Remaining: 498\nX-BurstLimit-Limit: 500\nX-DocuSign-TraceToken: 6103b440-xxxx-xxxx-xxxx-f0cdf55d121b\nContent-Disposition: file; filename=\"NDA.pdf\"; documentid=\"1\"\nX-DocuSign-Node: FABCFDEF\nDate: Wed, 12 May 2021 21:27:41 GMT\n\n%PDF-1.5\n%\n%Writing objects...\n4 0 obj\n. . .\n```\n\n(In an actual `curl` request you would use the `--output` switch to\nsave the PDF byte stream into a file.)\n\n### Related topics\n\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\n", "operationId": "Documents_GetDocument", "consumes": [], "produces": [ @@ -5935,7 +5755,7 @@ { "name": "documentId", "in": "path", - "description": "The ID of the document to retrieve. Alternatively, you can use one of the following special keywords:\n\n- `combined`: Retrieves all of the documents as a single PDF file.\n When the query parameter `certificate` is **true,** the certificate of completion is included in the PDF file.\n When the query parameter `certificate` is **false,** the certificate of completion is not included in the PDF file.\n- `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the certificate of completion.\n- `certificate`: Retrieves only the certificate of completion as a PDF file.\n- `portfolio`: Retrieves the envelope documents as a [PDF portfolio](https://helpx.adobe.com/acrobat/using/overview-pdf-portfolios.html).", + "description": "The ID of the document to retrieve. Alternatively, you can use one of the following special keywords:\n\n- `combined`: Retrieves a PDF file that contains the combined content of all of the documents. If the account option **Attach certification of completion to envelope** is on, then the Certificate of Completion is also included in the PDF file. You set this account option in the Admin tool on the **Signing Settings** screen, or by setting the `attachCompletedEnvelope` property in the `accountSettings` object to **true.**\n- `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the Certificate of Completion.\n- `certificate`: Retrieves the Certificate of Completion as a PDF file.\n", "required": true, "type": "string" }, @@ -5949,7 +5769,7 @@ { "name": "certificate", "in": "query", - "description": "Used only when the `documentId` parameter is the special keyword `combined`.\n\nWhen **true,** the certificate of completion is included in the combined PDF file.\nWhen **false,** (the default) the certificate of completion is not included in the combined PDF file.\n\n", + "description": "When **false,** the envelope signing certificate is removed from the download.", "required": false, "type": "string" }, @@ -5998,7 +5818,7 @@ { "name": "show_changes", "in": "query", - "description": "When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The account must have the **Highlight Data Changes** feature enabled.", + "description": "When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. ", "required": false, "type": "string" }, @@ -6471,9 +6291,9 @@ }, "deprecated": false, "x-ds-methodname": "getEnvelopeDocumentHtmlDefinitions", - "description": "", "x-ds-method": "get", "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] @@ -6575,9 +6395,9 @@ }, "deprecated": false, "x-ds-methodname": "getDocumentPageImages", - "description": "Returns images of the pages in a document for display based on the parameters that you specify.", "x-ds-method": "getPageImages", "x-ds-service": "Envelopes", + "description": "Returns images of the pages in a document for display based on the parameters that you specify.", "x-ds-in-sdk": true }, "parameters": [] @@ -6853,9 +6673,9 @@ }, "deprecated": false, "x-ds-methodname": "getPageTabs", - "description": "Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n", "x-ds-method": "getByPage", "x-ds-service": "Envelopes", + "description": "Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n", "x-ds-in-sdk": true }, "parameters": [] @@ -6917,9 +6737,9 @@ }, "deprecated": false, "x-ds-methodname": "createDocumentResponsiveHtmlPreview", - "description": "Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/)\nHTML version of a specific document.\nThis method enables you to preview a PDF document\nconversion to responsive HTML across device types prior to sending.\n\nThe request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.", "x-ds-method": "create", "x-ds-service": "Uncategorized", + "description": "Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/)\nHTML version of a specific document.\nThis method enables you to preview a PDF document\nconversion to responsive HTML across device types prior to sending.\n\nThe request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.", "x-ds-in-sdk": true }, "parameters": [] @@ -6986,9 +6806,9 @@ }, "deprecated": false, "x-ds-methodname": "getDocumentTabs", - "description": "Returns the tabs on the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n", "x-ds-method": "get", "x-ds-service": "Envelopes", + "description": "Returns the tabs on the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n", "x-ds-in-sdk": true }, "put": { @@ -7047,9 +6867,9 @@ }, "deprecated": false, "x-ds-methodname": "updateDocumentTabs", - "description": "Updates tabs in the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n", "x-ds-method": "update", "x-ds-service": "Uncategorized", + "description": "Updates tabs in the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n", "x-ds-in-sdk": true }, "post": { @@ -7108,9 +6928,9 @@ }, "deprecated": false, "x-ds-methodname": "createDocumentTabs", - "description": "Adds tabs to the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n\nIn the request body, you only need to specify the tabs that your\nare adding. For example, to add a text\n[prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs),\nyour request body might look like this:\n\n```\n{\n \"prefillTabs\": {\n \"textTabs\": [\n {\n \"value\": \"a prefill text tab\",\n \"pageNumber\": \"1\",\n \"documentId\": \"1\",\n \"xPosition\": 316,\n \"yPosition\": 97\n }\n ]\n }\n}\n```\n", "x-ds-method": "create", "x-ds-service": "Uncategorized", + "description": "Adds tabs to the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n\nIn the request body, you only need to specify the tabs that your\nare adding. For example, to add a text\n[prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs),\nyour request body might look like this:\n\n```\n{\n \"prefillTabs\": {\n \"textTabs\": [\n {\n \"value\": \"a prefill text tab\",\n \"pageNumber\": \"1\",\n \"documentId\": \"1\",\n \"xPosition\": 316,\n \"yPosition\": 97\n }\n ]\n }\n}\n```\n", "x-ds-in-sdk": true }, "delete": { @@ -7169,9 +6989,9 @@ }, "deprecated": false, "x-ds-methodname": "deleteDocumentTabs", - "description": "Deletes tabs from the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n", "x-ds-method": "delete", "x-ds-service": "Uncategorized", + "description": "Deletes tabs from the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n", "x-ds-in-sdk": true }, "parameters": [] @@ -7405,7 +7225,7 @@ "schema": { "$ref": "#/definitions/document" }, - "description": "An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically." + "description": "" } ], "responses": { @@ -7673,9 +7493,9 @@ }, "deprecated": false, "x-ds-methodname": "getFormData", - "description": "This 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.\n\n**Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account.\n\n### Related topics\n\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\n", "x-ds-method": "get", "x-ds-service": "Envelopes", + "description": "This 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.\n\n**Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account.\n\n### Related topics\n\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\n", "x-ds-in-sdk": true }, "parameters": [] @@ -7721,9 +7541,9 @@ }, "deprecated": false, "x-ds-methodname": "getEnvelopeHtmlDefinitions", - "description": "", "x-ds-method": "list", "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] @@ -7734,7 +7554,7 @@ "EnvelopeLocks" ], "summary": "Gets envelope lock information.", - "description": "Retrieves general information about an envelope lock.\n\nThe user requesting the information must be the same user\nwho locked the envelope.\n\nYou can use this method to recover the lock information,\nincluding the `lockToken`,\nfor a locked envelope.\nThe `X-DocuSign-Edit` header is included in the response.\n\nSee [EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nfor a description of the `X-DocuSign-Edit` header.\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\n\n", + "description": "Retrieves general information about an envelope lock.\n\nThe user requesting the information must be the same user\nwho locked the envelope.\n\nYou can use this method to recover the lock information,\nincluding the `lockToken`,\nfor a locked envelope.\nThe `X-DocuSign-Edit` header is included in the response.\n\nSee [EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nfor a description of the `X-DocuSign-Edit` header.\n", "operationId": "Lock_GetEnvelopeLock", "consumes": [], "produces": [], @@ -7833,7 +7653,7 @@ "EnvelopeLocks" ], "summary": "Locks an envelope.", - "description": "This method locks the specified envelope and sets the time until\nthe lock expires to prevent other users or recipients from\nchanging the envelope.\n\nThe response to this request includes a `lockToken` parameter\nthat you must use in the `X-DocuSign-Edit` header for\nevery PUT method (typically a method that updates an envelope)\nwhile the envelope is locked.\n\n\nIf you do not provide the `lockToken` when accessing\na locked envelope, you will get the following\nerror:\n\n```\n{\n \"errorCode\": \"EDIT_LOCK_NOT_LOCK_OWNER\",\n \"message\": \"The user is not the owner of the lock. The template is locked by another user or in another application\"\n}\n```\n\n\n### The X-DocuSign-Edit header\n\nThe `X-DocuSign-Edit` header looks like this\nand can be specified in either JSON or XML.\n\n**JSON**\n```\n{\n \"LockToken\": \"token-from-response\",\n \"LockDurationInSeconds\": \"600\"\n}\n```\n\n**XML**\n```\n\n token-from-response\n 600\n\n```\n\nIn the actual HTTP header, you would remove the linebreaks:\n\n```\nX-DocuSign-Edit: {\"LockToken\": \"token-from-response\", \"LockDurationInSeconds\": \"600\" }\n or\nX-DocuSign-Edit:token-from-response600\n```\n\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\n\n", + "description": "This method locks the specified envelope and sets the time until\nthe lock expires to prevent other users or recipients from\nchanging the envelope.\n\n**Note:** To use this method, the envelope locking\ncapability must be enabled for the user; that is, the user setting\n`canLockEnvelopes` must be set to **true.**\n\nThe response to this request includes a `lockToken` parameter\nthat you must use in the `X-DocuSign-Edit` header for\nevery PUT method (typically a method that updates an envelope)\nwhile the envelope is locked.\n\n\nIf you do not provide the `lockToken` when accessing\na locked envelope, you will get the following\nerror:\n\n```\n{\n \"errorCode\": \"EDIT_LOCK_NOT_LOCK_OWNER\",\n \"message\": \"The user is not the owner of the lock. The template is locked by another user or in another application\"\n}\n```\n\n\n### The X-DocuSign-Edit header\n\nThe `X-DocuSign-Edit` header looks like this\nand can be specified in either JSON or XML.\n\n**JSON**\n```\n{\n \"LockToken\": \"token-from-response\",\n \"LockDurationInSeconds\": \"600\"\n}\n```\n\n**XML**\n```\n\n token-from-response\n 600\n\n```\n\nIn the actual HTTP header, you would remove the linebreaks:\n\n```\nX-DocuSign-Edit: {\"LockToken\": \"token-from-response\", \"LockDurationInSeconds\": \"600\" }\n or\nX-DocuSign-Edit:token-from-response600\n```\n\n\n", "operationId": "Lock_PostEnvelopeLock", "consumes": [], "produces": [], @@ -7887,7 +7707,7 @@ "EnvelopeLocks" ], "summary": "Deletes an envelope lock.", - "description": "Deletes the lock from the specified envelope.\nThe user deleting the lock must be the same user\nwho locked the envelope.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\n\nThis method takes an optional query parameter\nthat lets you specify whether\nchanges made while the envelope was locked\nare kept or discarded.\n\n\n| Query Parameter | Description |\n| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `save_changes` | When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the envelope was locked are discarded. |\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\n\n", + "description": "Deletes the lock from the specified envelope.\nThe user deleting the lock must be the same user\nwho locked the envelope.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\n\nThis method takes an optional query paramter\nthat lets you specify whether\nchanges made while the envelope was locked\nare kept or discarded.\n\n\n| Query Parameter | Description |\n| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `save_changes` | (Optional) When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the envelope was locked are discarded. |", "operationId": "Lock_DeleteEnvelopeLock", "consumes": [], "produces": [], @@ -8024,9 +7844,9 @@ }, "deprecated": false, "x-ds-methodname": "updateNotificationSettings", - "description": "This 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.\n\nNote that this request only specifies when notifications are sent; it does not initiate sending of email messages.", "x-ds-method": "updateNotificationSettings", "x-ds-service": "Envelopes", + "description": "This 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.\n\nNote that this request only specifies when notifications are sent; it does not initiate sending of email messages.", "x-ds-in-sdk": true }, "parameters": [] @@ -8623,9 +8443,9 @@ }, "deprecated": false, "x-ds-methodname": "getRecipientDocumentVisibility", - "description": "This method returns information about document visibility for a recipient.", "x-ds-method": "get", "x-ds-service": "Envelopes", + "description": "This method returns information about document visibility for a recipient.", "x-ds-in-sdk": true }, "put": { @@ -8684,9 +8504,9 @@ }, "deprecated": false, "x-ds-methodname": "updateRecipientDocumentVisibility", - "description": "This method updates document visibility for a recipient.\n\n**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.", "x-ds-method": "update", "x-ds-service": "Envelopes", + "description": "This method updates document visibility for a recipient.\n\n**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.", "x-ds-in-sdk": true }, "parameters": [] @@ -8727,7 +8547,7 @@ "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/idEvidenceResourceToken" + "$ref": "#/definitions/proofServiceResourceToken" } }, "400": { @@ -8740,9 +8560,9 @@ "deprecated": false, "x-ds-methodname": "createRecipientProofFileResourceToken", "x-ds-api-status": "beta", - "description": "Creates 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/).", "x-ds-method": "createRecipientProofFileResourceToken", "x-ds-service": "Uncategorized", + "description": "Creates 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/).", "x-ds-in-sdk": true }, "parameters": [] @@ -8753,7 +8573,7 @@ "Envelopes" ], "summary": "Gets the initials image for a user.", - "description": "Retrieves the initials image for the specified user. The image is returned in the same format as 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.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint.\n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.", + "description": "Retrieves the initials image for the specified user. The image is returned in the same format as 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.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.", "operationId": "Recipients_GetRecipientInitialsImage", "consumes": [], "produces": [ @@ -9332,9 +9152,9 @@ }, "deprecated": false, "x-ds-methodname": "createRecipientManualReviewView", - "description": "This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient. ", "x-ds-method": "createRecipientManualReviewView", "x-ds-service": "Uncategorized", + "description": "This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient. ", "x-ds-in-sdk": true }, "parameters": [] @@ -9389,9 +9209,9 @@ }, "deprecated": false, "x-ds-methodname": "updateRecipientsDocumentVisibility", - "description": "This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n**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.", "x-ds-method": "updateRecipientsDocumentVisibility", "x-ds-service": "EnvelopeDocumentVisibility", + "description": "This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n**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.", "x-ds-in-sdk": true }, "parameters": [] @@ -9446,9 +9266,9 @@ }, "deprecated": false, "x-ds-methodname": "createResponsiveHtmlPreview", - "description": "Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents in an\nenvelope. This method enables you to preview the\nPDF document conversions to responsive HTML across\ndevice types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.\n", "x-ds-method": "create", "x-ds-service": "Uncategorized", + "description": "Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents in an\nenvelope. This method enables you to preview the\nPDF document conversions to responsive HTML across\ndevice types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.\n", "x-ds-in-sdk": true }, "parameters": [] @@ -9491,9 +9311,9 @@ }, "deprecated": false, "x-ds-methodname": "getTabsBlob", - "description": "", "x-ds-method": "getTabsBlob", "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "put": { @@ -9533,9 +9353,9 @@ }, "deprecated": false, "x-ds-methodname": "putTabsBlob", - "description": "", "x-ds-method": "putTabsBlob", "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] @@ -9662,7 +9482,7 @@ "EnvelopeViews" ], "summary": "Returns a URL to the envelope correction UI.", - "description": "Returns a URL that allows you to embed the envelope correction view of the DocuSign UI. To customize the appearance of the correction view, you can add special query parameters to the returned URL when you use it in your application.\n\nYou can revoke this URL by calling the [deleteEnvelopeCorrectView](/docs/esign-rest-api/reference/envelopes/envelopeviews/deleteenvelopecorrectview/) endpoint.\n\n## Best practices\n\nThe returned URL expires after 10 minutes and can only be used once. Therefore, request the URL immediately before you redirect your user to it.\n\nDue to screen space issues, do not use an `