{ "swagger": "2.0", "info": { "version": "v2.1", "title": "DocuSign REST API", "description": "The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.", "termsOfService": "https://www.docusign.com/company/terms-and-conditions/web", "contact": { "name": "DocuSign Developer Center", "url": "https://developers.docusign.com/", "email": "devcenter@docusign.com" } }, "host": "www.docusign.net", "basePath": "/restapi", "schemes": [ "https" ], "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json" ], "externalDocs": { "description": "See the DocuSign REST API Guide for more information.", "url": "https://docs.docusign.com/esign" }, "paths": { "/service_information": { "get": { "tags": [ "Services" ], "summary": "Retrieves the available REST API versions.", "description": "Retrieves the available REST API versions.\n\nDocuSign Production system: https://www.docusign.net/restapi/service_information\nDocuSign Demo system: https://demo.docusign.net/restapi/service_information\n\nYou do not need an integration key to view the REST API versions and resources.", "operationId": "ServiceInformation_GetServiceInformation", "consumes": [], "produces": [], "parameters": [], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/serviceInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getService", "x-ds-method": "get", "x-ds-service": "Diagnostics", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1": { "get": { "tags": [ "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", "operationId": "ServiceInformation_GetResourceInformation", "consumes": [], "produces": [], "parameters": [], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/resourceInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getResources", "x-ds-method": "get", "x-ds-service": "Diagnostics", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts": { "post": { "tags": [ "Accounts" ], "summary": "Creates new accounts.", "description": "Creates new DocuSign accounts.\nYou can use this method to create\na single account\nor up to 100 accounts at a time.\n\n**Note:** This method is restricted to partner integrations.\nYou must work with DocuSign Professional Services\nor DocuSign Business Development,\nwho will provide you with the Distributor Code\nand Distributor Password\nthat you need to include in the request body.\n\n\nWhen creating a single account,\nthe body of the request is a\n[`newAccountRequest`][newAccountRequest]\nobject.\n\nExample:\n\n```\n{\n \"newAccountRequest\": [\n {\n \"accountName\":\"Test Account\",\n \"distributorCode\":\"MY_DIST_CODE\",\n \"distributorPassword\":\"MY_DIST_PWD\",\n \"initialUser\":{\n \"email\":\"user@emaildomain.com\",\n \"firstName\":\"John\",\n \"middleName\": \"Harry\",\n \"lastName\":\"Doe\",\n \"suffixName\": \"\",\n \"userName\": \"John Doe\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Test Company\"\n },\n \"addressInformation\":{\n \"address1\": \"1234 Main Street\",\n \"address2\": \"Suite 100\",\n \"city\": \"Seattle\",\n \"state\": \"WA\",\n \"postalCode\": \"98101\",\n \"country\": \"US\",\n \"phone\": \"1234567890\",\n \"fax\": \"1234567891\"\n },\n \"planInformation\":{\n \"planId\":\"37085696-xxxx-xxxx-xxxx-7ea067752959\"\n },\n \"referralInformation\":{\n \"includedSeats\": \"1\",\n \"referralCode\": \"code\",\n \"referrerName\": \"name\"\n }\n }\n ]\n}\n\n```\nIf the request succeeds,\nit returns a\n201 (Created) HTTP response code.\nThe response returns the new account ID, password, and the default user\ninformation for each newly created account.\n\n\nWhen creating multiple accounts,\nthe body of the request is a\n`newAccountRequests`\nobject,\nwhich contains one or more\n[`newAccountDefinition`][newAccountDefinition]\nobjects.\nYou can create up to 100 new accounts\nat a time this way.\n\nThe body for a multi-account\ncreation request\nlooks like this in JSON:\n\n```\n{\n \"newAccountRequests\": [\n {\n \"accountName\": \"accountone\",\n . . .\n },\n {\n \"accountName\": \"accounttwo\",\n . . .\n }\n ]\n}\n```\n\nA multi-account request\nlooks like this in XML:\n\n```\n\n \n \n . . .\n \n \n . . .\n \n \n\n```\n\nA multi-account creation request\nmay succeed (report a 201 code)\neven if some accounts could not be created.\nIn this case, the `errorDetails` property\nin the response contains specific information\nabout the failure.\n\n\n\n[newAccountDefinition]: #/definitions/newAccountDefinition\n[nameValue]: #/definitions/nameValue\n[newAccountRequest]: #/definitions/newAccountRequest\n", "operationId": "Accounts_PostAccounts", "consumes": [], "produces": [], "parameters": [ { "name": "newAccountDefinition", "in": "body", "required": false, "schema": { "$ref": "#/definitions/newAccountDefinition" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/newAccountSummary" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "create", "x-ds-method": "create", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "summary": "Retrieves the account information for the specified account.", "description": "Retrieves the account information for the specified account.", "operationId": "Accounts_GetAccount", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "include_account_settings", "in": "query", "description": "When **true,** includes account settings in the response. The default value is **false.**", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/accountInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "GetAccountInformation", "x-ds-method": "get", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "delete": { "tags": [ "Accounts" ], "summary": "Deletes the specified account.", "description": "This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.", "operationId": "Accounts_DeleteAccount", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "redact_user_data", "in": "query", "required": false, "type": "string", "description": "" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "delete", "x-ds-method": "delete", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_charges": { "get": { "tags": [ "Accounts" ], "summary": "Gets list of recurring and usage charges for the account.", "description": "Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. \n\nPrivileges required: account administrator ", "operationId": "BillingCharges_GetAccountBillingCharges", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "include_charges", "in": "query", "description": "Specifies which billing charges to return.\nValid values are:\n\n* envelopes\n* seats\n", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/billingChargeResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getBillingCharges", "x-ds-method": "getBillingCharges", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_invoices": { "get": { "tags": [ "Invoices" ], "summary": "Get a List of Billing Invoices", "description": "Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.\n\nPrivileges required: account administrator ", "operationId": "BillingInvoices_GetBillingInvoices", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "from_date", "in": "query", "description": "Specifies the date/time of the earliest invoice in the account to retrieve.", "required": false, "type": "string" }, { "name": "to_date", "in": "query", "description": "Specifies the date/time of the latest invoice in the account to retrieve.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/billingInvoicesResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listInvoices", "x-ds-method": "list", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_invoices/{invoiceId}": { "get": { "tags": [ "Invoices" ], "summary": "Retrieves a billing invoice.", "description": "Retrieves the specified invoice.\n\n**Note:** If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.\n\nPrivileges required: account administrator\n\nThe response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.\n\n**Response**\nThe following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |", "operationId": "BillingInvoices_GetBillingInvoice", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "invoiceId", "in": "path", "required": true, "type": "string", "description": "The ID of the invoice." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/billingInvoice" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getInvoice", "x-ds-method": "get", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_invoices_past_due": { "get": { "tags": [ "Invoices" ], "summary": "Get a list of past due invoices.", "description": "Returns a list past due invoices for the account and notes if payment can be made through the REST API. \n\nPrivileges Required: account administrator", "operationId": "BillingInvoices_GetBillingInvoicesPastDue", "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/billingInvoicesSummary" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listInvoicesPastDue", "x-ds-method": "listPastDue", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_payments": { "get": { "tags": [ "Payments" ], "summary": "Gets payment information for one or more payments.", "description": "Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. \n\nPrivileges required: account administrator ", "operationId": "BillingPayments_GetPaymentList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "from_date", "in": "query", "description": "Specifies the date/time of the earliest payment in the account to retrieve.", "required": false, "type": "string" }, { "name": "to_date", "in": "query", "description": "Specifies the date/time of the latest payment in the account to retrieve.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/billingPaymentsResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listPayments", "x-ds-method": "list", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "post": { "tags": [ "Payments" ], "summary": "Posts a payment to a past due invoice.", "description": "Posts a payment to a past due invoice.\n\nThis method can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [Billing::listInvoicesPastDue](/docs/esign-rest-api/reference/billing/invoices/listpastdue/).\n\nThe response returns information for a single payment\nif a payment ID was used in the endpoint, or a list of payments.\nIf the from date or to date queries or payment ID are not used,\nthe response returns payment information for the last 365 days.\n\nIf the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.\n\nPrivileges required: account administrator\n", "operationId": "BillingPayments_PostPayment", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "billingPaymentRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/billingPaymentRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/billingPaymentResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "makePayment", "x-ds-method": "create", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_payments/{paymentId}": { "get": { "tags": [ "Payments" ], "summary": "Gets billing payment information for a specific payment.", "description": "Retrieves the information for a specified payment. \n\nPrivileges required: account administrator ", "operationId": "BillingPayments_GetPayment", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "paymentId", "in": "path", "required": true, "type": "string", "description": "The ID of the payment." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/billingPaymentItem" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getPayment", "x-ds-method": "get", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_plan": { "get": { "tags": [ "BillingPlans" ], "summary": "Get Account Billing Plan", "description": "Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.\n\nBy default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to **false.**\n\nResponse\n\nThe response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [Billing: getBillingPlan](/docs/esign-rest-api/reference/billing/billingplans/get/) reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [Billing: updatePlan](/docs/esign-rest-api/reference/billing/billingplans/update/) reference.\n\n**Note:** When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.\n", "operationId": "BillingPlan_GetBillingPlan", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "include_credit_card_information", "in": "query", "description": "When **true,** payment information including credit card information will show in the return.", "required": false, "type": "string" }, { "name": "include_downgrade_information", "in": "query", "required": false, "type": "string", "description": "" }, { "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. ", "required": false, "type": "string" }, { "name": "include_successor_plans", "in": "query", "description": "When **true,** excludes successor information from the response.", "required": false, "type": "string" }, { "name": "include_tax_exempt_id", "in": "query", "required": false, "type": "string", "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/accountBillingPlanResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getPlan", "x-ds-method": "getAccountPlan", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "put": { "tags": [ "BillingPlans" ], "summary": "Updates an account billing plan.", "description": "Updates the billing plan information, billing address, and credit card information for the specified account.", "operationId": "BillingPlan_PutBillingPlan", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "preview_billing_plan", "in": "query", "description": "When **true,** updates the account using a preview billing plan.", "required": false, "type": "string" }, { "name": "billingPlanInformation", "in": "body", "required": false, "schema": { "$ref": "#/definitions/billingPlanInformation" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/billingPlanUpdateResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updatePlan", "x-ds-method": "update", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_plan/credit_card": { "get": { "tags": [ "BillingPlans" ], "summary": "Get credit card information", "operationId": "BillingPlan_GetCreditCardInfo", "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/creditCardInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_plan/downgrade": { "get": { "tags": [ "BillingPlans" ], "summary": "Returns downgrade plan information for the specified account.", "operationId": "BillingPlan_GetDowngradeRequestBillingInfo", "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/downgradRequestBillingInfoResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getDowngradeRequestBillingInfo", "description": "", "x-ds-method": "getDowngradeRequestBillingInfo", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "put": { "tags": [ "BillingPlans" ], "summary": "Queues downgrade billing plan request for an account.", "operationId": "BillingPlan_PutDowngradeAccountBillingPlan", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "downgradeBillingPlanInformation", "in": "body", "required": false, "schema": { "$ref": "#/definitions/downgradeBillingPlanInformation" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/downgradePlanUpdateResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateDowngradeAccountBillingPlan", "description": "", "x-ds-method": "updateDowngradeAccountBillingPlan", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes": { "put": { "tags": [ "BillingPlans" ], "summary": "Reserved: 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": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "purchasedEnvelopesInformation", "in": "body", "required": false, "schema": { "$ref": "#/definitions/purchasedEnvelopesInformation" }, "description": "" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "purchaseEnvelopes", "x-ds-method": "purchaseEnvelopes", "x-ds-service": "Billing", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/brands": { "get": { "tags": [ "AccountBrands" ], "summary": "Gets a list of brands.", "description": "This method returns details about all of the brands associated with an account,\nincluding the default brand profiles.\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n", "operationId": "Brands_GetBrands", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "exclude_distributor_brand", "in": "query", "description": "When **true,** excludes distributor brand information from the response set.", "required": false, "type": "string" }, { "name": "include_logos", "in": "query", "description": "When **true,** returns the logos associated with the brand.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountBrands" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listBrands", "x-ds-method": "list", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "post": { "tags": [ "AccountBrands" ], "summary": "Creates one or more brand profiles for an account.", "description": "This method creates one or more brand profile files for an account.\n\nTo specify logos for the brand,\nuse the\n[AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/)\nmethod\nafter you create the brand.\n\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n", "operationId": "Brands_PostBrands", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brand", "in": "body", "required": false, "schema": { "$ref": "#/definitions/brand" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountBrands" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createBrand", "x-ds-method": "create", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "delete": { "tags": [ "AccountBrands" ], "summary": "Deletes one or more brand profiles.", "description": "This method deletes one or more brand profiles from an account, based on the brand IDs that you include in the `brandsRequest`.\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n", "operationId": "Brands_DeleteBrands", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandsRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/brandsRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountBrands" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteBrands", "x-ds-method": "deleteList", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/brands/{brandId}": { "get": { "tags": [ "AccountBrands" ], "summary": "Gets information about a brand.", "operationId": "Brand_GetBrand", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" }, { "name": "include_external_references", "in": "query", "required": false, "type": "string", "description": "When **true,** the landing pages and links associated with the brand are included in the response." }, { "name": "include_logos", "in": "query", "required": false, "type": "string", "description": "When **true,** the URIs for the logos associated with the brand are included in the response." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/brand" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "put": { "tags": [ "AccountBrands" ], "summary": "Updates an existing brand.", "operationId": "Brand_PutBrand", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" }, { "name": "replace_brand", "in": "query", "required": false, "type": "string", "description": "When **true,** replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The default value is **false.**" }, { "name": "brand", "in": "body", "required": false, "schema": { "$ref": "#/definitions/brand" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/brand" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "delete": { "tags": [ "AccountBrands" ], "summary": "Deletes a brand.", "operationId": "Brand_DeleteBrand", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/brands/{brandId}/file": { "get": { "tags": [ "AccountBrands" ], "summary": "Exports a brand.", "operationId": "BrandExport_GetBrandExportFile", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}": { "get": { "tags": [ "AccountBrands" ], "summary": "Gets a brand logo.", "operationId": "BrandLogo_GetBrandLogo", "consumes": [], "produces": [ "image/png" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" }, { "name": "logoType", "in": "path", "description": "The type of logo. Valid values are:\n\n- `primary` \n- `secondary` \n- `email`", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "type": "file" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "put": { "tags": [ "AccountBrands" ], "summary": "Updates a brand logo.", "operationId": "BrandLogo_PutBrandLogo", "consumes": [ "image/png" ], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" }, { "name": "logoType", "in": "path", "description": "The type of logo. Valid values are:\n\n- `primary` \n- `secondary` \n- `email`", "required": true, "type": "string" }, { "name": "logoFileBytes", "in": "body", "description": "Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places", "required": true, "schema": { "type": "string", "format": "binary" } } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "delete": { "tags": [ "AccountBrands" ], "summary": "Deletes a brand logo.", "operationId": "BrandLogo_DeleteBrandLogo", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" }, { "name": "logoType", "in": "path", "description": "The type of logo. Valid values are:\n\n- `primary` \n- `secondary` \n- `email`", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/brands/{brandId}/resources": { "get": { "tags": [ "AccountBrands" ], "summary": "Returns metadata about the branding resources for an account.", "operationId": "BrandResources_GetBrandResourcesList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/brandResourcesList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}": { "get": { "tags": [ "AccountBrands" ], "summary": "Returns a branding resource file.", "operationId": "BrandResources_GetBrandResources", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" }, { "name": "resourceContentType", "in": "path", "required": true, "type": "string", "description": "The type of brand resource file to return. Valid values are:\n\n- `sending`\n- `signing`\n- `email`\n- `signing_captive`" }, { "name": "langcode", "in": "query", "required": false, "type": "string", "description": "The ISO 3166-1 alpha-2 codes for the languages that the brand supports." }, { "name": "return_master", "in": "query", "required": false, "type": "string", "description": "Specifies which resource file data to return. When **true,** only the master resource file is returned. When **false,** only the elements that you modified are returned." } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "put": { "tags": [ "AccountBrands" ], "summary": "Updates a branding resource file.", "operationId": "BrandResources_PutBrandResources", "consumes": [ "multipart/form-data" ], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "brandId", "in": "path", "description": "The ID of the brand.", "required": true, "type": "string" }, { "name": "resourceContentType", "in": "path", "required": true, "type": "string", "description": "The type of brand resource file that you are updating. Valid values are:\n\n- `sending`\n- `signing`\n- `email`\n- `signing_captive`" }, { "name": "file.xml", "in": "formData", "description": "Brand resource XML file.", "required": true, "type": "file" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/brandResources" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/bulk_send_batch": { "get": { "tags": [ "BulkSend" ], "summary": "Returns a list of bulk send batch summaries. ", "operationId": "BulkSendV2Batch_GetBulkSendBatches", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "batch_ids", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of batch IDs to query." }, { "name": "count", "in": "query", "required": false, "type": "string", "description": "The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `100`
\nDefault: `100`" }, { "name": "from_date", "in": "query", "required": false, "type": "string", "description": "The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied." }, { "name": "search_text", "in": "query", "required": false, "type": "string", "description": "Use this parameter to search for specific text." }, { "name": "start_position", "in": "query", "required": false, "type": "string", "description": "The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n" }, { "name": "status", "in": "query", "required": false, "type": "string", "description": "The kind of results to collect. Must be one of:\n\n- all\n- failed\n- sent\n- queued" }, { "name": "to_date", "in": "query", "required": false, "type": "string", "description": "The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date." }, { "name": "user_id", "in": "query", "required": false, "type": "string", "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendBatchSummaries" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}": { "get": { "tags": [ "BulkSend" ], "summary": "Gets the status of a specific bulk send batch.", "operationId": "BulkSendV2Batch_GetBulkSendBatchStatus", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkSendBatchId", "in": "path", "required": true, "type": "string", "description": "The batch ID." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendBatchStatus" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "put": { "tags": [ "BulkSend" ], "summary": "Updates the name of a bulk send batch.", "operationId": "BulkSendV2Batch_PutBulkSendBatchStatus", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkSendBatchId", "in": "path", "required": true, "type": "string", "description": "The batch ID." }, { "name": "bulkSendBatchRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/bulkSendBatchRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendBatchStatus" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateBulkSendBatchStatus", "description": "Updates the name of a bulk send batch.", "x-ds-method": "updateBulkSendBatchStatus", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}": { "put": { "tags": [ "BulkSend" ], "summary": "Applies a bulk action to all envelopes from a specified bulk send.", "operationId": "BulkSendV2Batch_PutBulkSendBatchAction", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkAction", "in": "path", "required": true, "type": "string", "description": "The action to apply. Valid values:\n* `resend`\n* `correct`\n* `void`\n" }, { "name": "bulkSendBatchId", "in": "path", "required": true, "type": "string", "description": "The batch ID." }, { "name": "bulkSendBatchActionRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/bulkSendBatchActionRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendBatchStatus" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateBulkSendBatchAction", "description": "Use this endpoint to resend, correct, or void all envelopes from a specified bulk send.", "x-ds-method": "updateBulkSendBatchAction", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes": { "get": { "tags": [ "BulkSend" ], "summary": "Gets envelopes from a specific bulk send batch.", "operationId": "BulkSendV2Envelopes_GetBulkSendBatchEnvelopes", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkSendBatchId", "in": "path", "required": true, "type": "string", "description": "The batch ID." }, { "name": "count", "in": "query", "required": false, "type": "string", "description": "The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `1000`\n" }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "When `recipients`, only envelopes with recipient nodes will be included in the response." }, { "name": "order", "in": "query", "required": false, "type": "string", "description": "The order in which to sort the results. Valid values are:\n\n- Descending order: `desc` (default)\n- Ascending order: `asc`" }, { "name": "order_by", "in": "query", "required": false, "type": "string", "description": "The envelope attribute used to sort the results. Valid values are:\n\n- `created` (default)\n- `completed`\n- `last_modified`\n- `sent`\n- `status`\n- `subject`\n- `status_changed`" }, { "name": "search_text", "in": "query", "required": false, "type": "string", "description": "Use this parameter to search for specific text." }, { "name": "start_position", "in": "query", "required": false, "type": "string", "description": "The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n" }, { "name": "status", "in": "query", "required": false, "type": "string", "description": "Comma-separated list of envelope statuses.\n\nNote that `any` should not be included with other statuses. In other words, `any` is a valid parameter value, but `any,sent` is not.\n\nUse the value `deliveryfailure` to get all envelopes with `AuthFailed` and `AutoResponded` status. This value is specific to bulk sending." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopesInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/bulk_send_lists": { "get": { "tags": [ "BulkSend" ], "summary": "Gets bulk send lists.", "operationId": "BulkSendV2CRUD_GetBulkSendLists", "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/bulkSendingListSummaries" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "post": { "tags": [ "BulkSend" ], "summary": "Creates a bulk send list.", "operationId": "BulkSendV2CRUD_PostBulkSendList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the account.", "required": true, "type": "string" }, { "name": "bulkSendingList", "in": "body", "required": false, "schema": { "$ref": "#/definitions/bulkSendingList" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendingList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}": { "get": { "tags": [ "BulkSend" ], "summary": "Gets a specific bulk send list.", "operationId": "BulkSendV2CRUD_GetBulkSendList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkSendListId", "in": "path", "required": true, "type": "string", "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendingList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "put": { "tags": [ "BulkSend" ], "summary": "Updates a bulk send list.", "operationId": "BulkSendV2CRUD_PutBulkSendList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkSendListId", "in": "path", "required": true, "type": "string", "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." }, { "name": "bulkSendingList", "in": "body", "required": false, "schema": { "$ref": "#/definitions/bulkSendingList" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendingList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "delete": { "tags": [ "BulkSend" ], "summary": "Deletes a bulk send list.", "operationId": "BulkSendV2CRUD_DeleteBulkSendList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkSendListId", "in": "path", "required": true, "type": "string", "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendingListSummaries" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteBulkSendList", "description": "This method deletes a bulk send list.", "x-ds-method": "deleteBulkSendList", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send": { "post": { "tags": [ "BulkSend" ], "summary": "Creates a bulk send request.", "operationId": "BulkSendV2Send_PostBulkSendRequest", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkSendListId", "in": "path", "required": true, "type": "string", "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." }, { "name": "bulkSendRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/bulkSendRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test": { "post": { "tags": [ "BulkSend" ], "summary": "Creates a bulk send test.", "operationId": "BulkSendV2Test_PostBulkSendTestRequest", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "bulkSendListId", "in": "path", "required": true, "type": "string", "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." }, { "name": "bulkSendRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/bulkSendRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/bulkSendTestResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}": { "delete": { "tags": [ "Accounts" ], "summary": "Deletes the signature for one or more captive recipient records.", "description": "This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.", "operationId": "CaptiveRecipients_DeleteCaptiveRecipientsPart", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "recipientPart", "in": "path", "required": true, "type": "string", "description": "Signature is the only supported value. " }, { "name": "captiveRecipientInformation", "in": "body", "required": false, "schema": { "$ref": "#/definitions/captiveRecipientInformation" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/captiveRecipientInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteCaptiveRecipient", "x-ds-method": "deleteCaptiveRecipient", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/chunked_uploads": { "post": { "tags": [ "ChunkedUploads" ], "summary": "Initiate a new chunked upload.", "operationId": "ChunkedUploads_PostChunkedUploads", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "chunkedUploadRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/chunkedUploadRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/chunkedUploadResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}": { "get": { "tags": [ "ChunkedUploads" ], "summary": "Retrieves metadata about a chunked upload.", "operationId": "ChunkedUploads_GetChunkedUpload", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "chunkedUploadId", "in": "path", "required": true, "type": "string", "description": "The ID of the chunked upload. " }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/chunkedUploadResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "put": { "tags": [ "ChunkedUploads" ], "summary": "Commit a chunked upload.", "operationId": "ChunkedUploads_PutChunkedUploads", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "(Required) The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "chunkedUploadId", "in": "path", "required": true, "type": "string", "description": "(Required) The ID of the chunked upload to commit." }, { "name": "action", "in": "query", "required": false, "type": "string", "description": "(Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload for use with other API calls." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/chunkedUploadResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "delete": { "tags": [ "ChunkedUploads" ], "summary": "Deletes a chunked upload.", "operationId": "ChunkedUploads_DeleteChunkedUpload", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "chunkedUploadId", "in": "path", "required": true, "type": "string", "description": "The ID of the chunked upload. " } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/chunkedUploadResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}": { "put": { "tags": [ "ChunkedUploads" ], "summary": "Add a chunk to an existing chunked upload.", "operationId": "ChunkedUploads_PutChunkedUploadPart", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "chunkedUploadId", "in": "path", "required": true, "type": "string", "description": "The ID of the chunked upload. " }, { "name": "chunkedUploadPartSeq", "in": "path", "required": true, "type": "string", "description": "The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create request is `0`.\n\n**Note:** You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it." }, { "name": "chunkedUploadRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/chunkedUploadRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/chunkedUploadResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect": { "get": { "tags": [ "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.", "operationId": "Connect_GetConnectConfigs", "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/connectConfigResults" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listConfigurations", "x-ds-method": "list", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "put": { "tags": [ "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.", "operationId": "Connect_PutConnectConfiguration", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "connectCustomConfiguration", "in": "body", "required": false, "schema": { "$ref": "#/definitions/connectCustomConfiguration" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectCustomConfiguration" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateConfiguration", "x-ds-method": "update", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "post": { "tags": [ "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.", "operationId": "Connect_PostConnectConfiguration", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "connectCustomConfiguration", "in": "body", "required": false, "schema": { "$ref": "#/definitions/connectCustomConfiguration" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectCustomConfiguration" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createConfiguration", "x-ds-method": "create", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/{connectId}": { "get": { "tags": [ "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", "operationId": "Connect_GetConnectConfig", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "connectId", "in": "path", "description": "The ID of the custom Connect configuration being accessed.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectConfigResults" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getConfiguration", "x-ds-method": "get", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "delete": { "tags": [ "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", "operationId": "Connect_DeleteConnectConfig", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "connectId", "in": "path", "description": "The ID of the custom Connect configuration being accessed.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteConfiguration", "x-ds-method": "delete", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/{connectId}/all/users": { "get": { "tags": [ "ConnectConfigurations" ], "summary": "Returns all users from the configured Connect service.", "operationId": "Connect_GetConnectAllUsers", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "connectId", "in": "path", "description": "The ID of the custom Connect configuration being accessed.", "required": true, "type": "string" }, { "name": "count", "in": "query", "required": false, "type": "string", "description": "The maximum number of results to return." }, { "name": "domain_users_only", "in": "query", "required": false, "type": "string", "description": "" }, { "name": "email_substring", "in": "query", "required": false, "type": "string", "description": "Filters returned user records by full email address or a substring of email address." }, { "name": "start_position", "in": "query", "required": false, "type": "string", "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." }, { "name": "status", "in": "query", "required": false, "type": "string", "description": "The status of the item." }, { "name": "user_name_substring", "in": "query", "required": false, "type": "string", "description": "Filters results based on a full or partial user name.\n\n**Note:** When you enter a partial user name, you do not use a wildcard character." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/integratedConnectUserInfoList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/{connectId}/users": { "get": { "tags": [ "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.", "operationId": "Connect_GetConnectUsers", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "connectId", "in": "path", "description": "The ID of the custom Connect configuration being accessed.", "required": true, "type": "string" }, { "name": "count", "in": "query", "required": false, "type": "string", "description": "The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\n" }, { "name": "email_substring", "in": "query", "required": false, "type": "string", "description": "Filters returned user records by full email address or a substring of email address." }, { "name": "list_included_users", "in": "query", "required": false, "type": "string", "description": "" }, { "name": "start_position", "in": "query", "required": false, "type": "string", "description": "The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n" }, { "name": "status", "in": "query", "required": false, "type": "string", "description": "Filters the results by user status.\nYou can specify a comma-separated\nlist of the following statuses:\n\n* ActivationRequired \n* ActivationSent \n* Active\n* Closed \n* Disabled\n" }, { "name": "user_name_substring", "in": "query", "required": false, "type": "string", "description": "Filters results based on a full or partial user name.\n\n**Note:** When you enter a partial user name, you do not use a wildcard character." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/integratedUserInfoList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "connectUsers", "x-ds-method": "listUsers", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue": { "put": { "tags": [ "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.", "operationId": "ConnectPublish_PutConnectRetryByEnvelope", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectFailureResults" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "retryEventForEnvelope", "x-ds-method": "retryForEnvelope", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "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\nThe envelope data will always be transmitted in JSON format. XML, Salesforce, and eOriginal configuration types are not supported.\n\nYour request should match the following format:\n\n```\n{\n \"envelopes\": [\"4280f274-xxxx-xxxx-xxxx-b218b7eeda08\", \"8373a938-xxxx-xxxx-xxxx-e992a2abae01\"],\n \"config\": {\n \"configurationType\":\"custom\",\n \"name\": \"Test\",\n \"urlToPublishTo\":\"YOUR-WEBHOOK-URL\",\n \"allowEnvelopePublish\": \"true\",\n \"enableLog\": \"true\",\n \"requiresAcknowledgement\": \"true\",\n \"IncludeHMAC\": \"true\",\n \"SignMessageWithX509Cert\": \"true\",\n \"deliveryMode\": \"SIM\",\n \"eventData\": {\n \"version\": \"restv2.1\",\n \"format\": \"json\",\n \"includedata\": [\"tabs\",\"payment_tabs\",\"custom_fields\",\"powerform\",\"recipients\",\"folders\",\"extensions\",\"attachments\", \"prefill_tabs\", \"documents\"]\n }\n }\n}\n```\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?bundleId=pik1583277475390&topicId=nvf1648497452396.html).", "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.", "operationId": "ConnectPublish_PutConnectRetry", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "connectFailureFilter", "in": "body", "required": false, "schema": { "$ref": "#/definitions/connectFailureFilter" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectFailureResults" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "retryEventForEnvelopes", "x-ds-method": "retryForEnvelopes", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/failures": { "get": { "tags": [ "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.", "operationId": "ConnectFailures_GetConnectLogs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "from_date", "in": "query", "required": false, "type": "string", "description": "The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied." }, { "name": "to_date", "in": "query", "required": false, "type": "string", "description": "The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectLogs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listEventFailureLogs", "x-ds-method": "listFailures", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/failures/{failureId}": { "delete": { "tags": [ "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.", "operationId": "ConnectFailures_DeleteConnectFailureLog", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "failureId", "in": "path", "description": "The ID of the Connect post failure. Use `all` to delete all failures for the account.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectDeleteFailureResult" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteEventFailureLog", "x-ds-method": "deleteFailure", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/logs": { "get": { "tags": [ "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. Log entries are deleted after 15 days.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.", "operationId": "ConnectLog_GetConnectLogs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "from_date", "in": "query", "required": false, "type": "string", "description": "The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied." }, { "name": "to_date", "in": "query", "required": false, "type": "string", "description": "The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectLogs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listEventLogs", "x-ds-method": "list", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "delete": { "tags": [ "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.", "operationId": "ConnectLog_DeleteConnectLogs", "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": "deleteEventLogs", "x-ds-method": "deleteList", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/logs/{logId}": { "get": { "tags": [ "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.", "operationId": "ConnectLog_GetConnectLog", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "logId", "in": "path", "description": "The ID of the Connect log entry.", "required": true, "type": "string" }, { "name": "additional_info", "in": "query", "description": "When **true,** the response includes the `connectDebugLog` information.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectLog" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getEventLog", "x-ds-method": "get", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "delete": { "tags": [ "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.", "operationId": "ConnectLog_DeleteConnectLog", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "logId", "in": "path", "description": "The ID of the Connect log entry.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteEventLog", "x-ds-method": "delete", "x-ds-service": "Connect", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/connect/oauth": { "get": { "tags": [ "ConnectConfigurations" ], "summary": "Retrieves the Connect OAuth information 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": "Gets the Connect OAuth configuration 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.\n\n## Related topics:\n- [OAuth for DocuSign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\n", "x-ds-in-sdk": true }, "put": { "tags": [ "ConnectConfigurations" ], "summary": "Updates the existing Connect OAuth configuration for the account.\n", "operationId": "ConnectOAuthConfig_PutConnectOAuthConfig", "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": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/connectOAuthConfig" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateConnectOAuthConfig", "x-ds-method": "updateConnectOAuthConfig", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "post": { "tags": [ "ConnectConfigurations" ], "summary": "Set up Connect OAuth for the specified 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": "Sets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server.\n\nWhen you call this endpoint, DocuSign requests an access token from your authorization server. DocuSign will use that token in the Authorization HTTP header of your account's Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n## Related topics:\n- [OAuth for DocuSign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\n", "x-ds-in-sdk": true }, "delete": { "tags": [ "ConnectConfigurations" ], "summary": "Delete the Connect OAuth configuration.", "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": "Deletes the Connect OAuth configuration 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.\n\n## Related topics:\n- [OAuth for DocuSign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\n", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/consumer_disclosure": { "get": { "tags": [ "AccountConsumerDisclosures" ], "summary": "Gets the default Electronic Record and Signature Disclosure for an account.", "description": "Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. \n\nThis is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.", "operationId": "ConsumerDisclosure_GetConsumerDisclosure", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "langCode", "in": "query", "description": "The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountConsumerDisclosures" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getConsumerDisclosureDefault", "x-ds-method": "getDefault", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}": { "get": { "tags": [ "AccountConsumerDisclosures" ], "summary": "Gets the Electronic Record and Signature Disclosure for an account.", "description": "Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. \n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.\n\n**Note:** The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the `langCode` parameter to specify the signer language version that you want to retrieve. ", "operationId": "ConsumerDisclosure_GetConsumerDisclosureLangCode", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "langCode", "in": "path", "description": "The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountConsumerDisclosures" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getConsumerDisclosure", "x-ds-method": "get", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "put": { "tags": [ "AccountConsumerDisclosures" ], "summary": "Updates the Electronic Record and Signature Disclosure for an account.", "operationId": "ConsumerDisclosure_PutConsumerDisclosure", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "langCode", "in": "path", "description": "The code for the signer language version of the disclosure that you want to update. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "required": true, "type": "string" }, { "name": "include_metadata", "in": "query", "required": false, "type": "string", "description": "(Optional) When true, the response includes metadata indicating which properties are editable." }, { "name": "consumerDisclosure", "in": "body", "required": false, "schema": { "$ref": "#/definitions/consumerDisclosure" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/consumerDisclosure" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/contacts": { "put": { "tags": [ "Contacts" ], "summary": "Updates one or more contacts.", "operationId": "Contacts_PutContacts", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "contactModRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/contactModRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/contactUpdateResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "post": { "tags": [ "Contacts" ], "summary": "Add contacts to a contacts list.", "operationId": "Contacts_PostContacts", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "contactModRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/contactModRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/contactUpdateResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "postContacts", "description": "This method adds multiple contacts into a contacts list.", "x-ds-method": "create", "x-ds-service": "Users", "x-ds-in-sdk": true }, "delete": { "tags": [ "Contacts" ], "summary": "Deletes multiple contacts from an account.", "operationId": "Contacts_DeleteContacts", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "contactModRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/contactModRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/contactUpdateResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteContacts", "description": "This method deletes multiple contacts associated with an account.", "x-ds-method": "deleteList", "x-ds-service": "Users", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/contacts/{contactId}": { "get": { "tags": [ "Contacts" ], "summary": "Gets one or more contacts.", "operationId": "Contacts_GetContactById", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "contactId", "in": "path", "description": "The ID of a contact person in the account's address book.\n\n**Note:** To return all contacts, omit this parameter. It is not required.", "required": true, "type": "string" }, { "name": "cloud_provider", "in": "query", "required": false, "type": "string", "description": "(Optional) The cloud provider from which to retrieve the contacts. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/contactGetResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "delete": { "tags": [ "Contacts" ], "summary": "Deletes a contact.", "operationId": "Contacts_DeleteContactWithId", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "contactId", "in": "path", "description": "The ID of a contact person in the account's address book.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/contactUpdateResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteContactWithId", "description": "This method deletes a contact associated with an account.", "x-ds-method": "delete", "x-ds-service": "Users", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/custom_fields": { "get": { "tags": [ "AccountCustomFields" ], "summary": "Gets a list of custom fields.", "description": "This method returns a list of the envelope and document custom fields associated with an account.", "operationId": "AccountCustomFields_GetAccountCustomFields", "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/AccountCustomFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listCustomFields", "x-ds-method": "list", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "post": { "tags": [ "AccountCustomFields" ], "summary": "Creates an account custom field.", "operationId": "AccountCustomFields_PostAccountCustomFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "apply_to_templates", "in": "query", "required": false, "type": "string", "description": "(Optional) When **true,** the new custom field is applied to all of the templates on the account." }, { "name": "customField", "in": "body", "required": false, "schema": { "$ref": "#/definitions/customField" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountCustomFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/custom_fields/{customFieldId}": { "put": { "tags": [ "AccountCustomFields" ], "summary": "Updates an account custom field.", "operationId": "AccountCustomFields_PutAccountCustomFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "customFieldId", "in": "path", "required": true, "type": "string", "description": "The ID of the custom field." }, { "name": "apply_to_templates", "in": "query", "required": false, "type": "string", "description": "" }, { "name": "customField", "in": "body", "required": false, "schema": { "$ref": "#/definitions/customField" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountCustomFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateCustomField", "description": "This method updates an existing account custom field.", "x-ds-method": "update", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "delete": { "tags": [ "AccountCustomFields" ], "summary": "Deletes an account custom field.", "operationId": "AccountCustomFields_DeleteAccountCustomFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "customFieldId", "in": "path", "required": true, "type": "string", "description": "The ID of the custom field." }, { "name": "apply_to_templates", "in": "query", "required": false, "type": "string", "description": "" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteCustomField", "description": "This method deletes an existing account custom field.", "x-ds-method": "delete", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes": { "get": { "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\nThis method excludes envelopes older than six months.\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\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", "operationId": "Envelopes_GetEnvelopes", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "ac_status", "in": "query", "description": "Specifies the Authoritative Copy Status for the envelopes. Valid values: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.", "required": false, "type": "string" }, { "name": "block", "in": "query", "required": false, "type": "string", "description": "Reserved for DocuSign.\n" }, { "name": "cdse_mode", "in": "query", "required": false, "type": "string", "description": "Reserved for DocuSign.\n" }, { "name": "continuation_token", "in": "query", "required": false, "type": "string", "description": "Reserved for DocuSign." }, { "name": "count", "in": "query", "required": false, "type": "string", "description": "The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n" }, { "name": "custom_field", "in": "query", "description": "Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value`\n\nExample: If you have an envelope custom field named \"Region\" and you want to search for all envelopes where the value is \"West\" you would use set this parameter to `Region=West`. \n \n", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string", "description": "Limit results to envelopes\nsent by the account user\nwith this email address.\n\n`user_name` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.\n" }, { "name": "envelope_ids", "in": "query", "required": false, "type": "string", "description": "Comma separated list of `envelopeId` values." }, { "name": "exclude", "in": "query", "required": false, "type": "string", "description": "Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`). Valid values are:\n\n- `recipients`\n- `powerforms`\n- `folders`" }, { "name": "folder_ids", "in": "query", "required": false, "type": "string", "description": "Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values: \n\n- `awaiting_my_signature`\n- `completed`\n- `draft`\n- `drafts`\n- `expiring_soon`\n- `inbox`\n- `out_for_signature`\n- `recyclebin`\n- `sentitems`\n- `waiting_for_others`" }, { "name": "folder_types", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of folder types you want to retrieve envelopes from. Valid values are: \n\n- `normal`\n- `inbox`\n- `sentitems`\n- `draft`\n- `templates`" }, { "name": "from_date", "in": "query", "description": "Specifies the date and time\nto start looking for status changes.\nThis parameter is required\nunless `envelopeIds` or `transactionIds`\nare set.\n\n\nAlthough you can use any date format\nsupported by the .NET system library's\n[`DateTime.Parse()`][msoft] function,\nDocuSign recommends\nusing [ISO 8601][] format dates\nwith an explicit time zone offset\nIf you do not provide\na time zone offset,\nthe method uses the server's time zone.\n\nFor example, the following dates and times refer to the same instant:\n\n* `2017-05-02T01:44Z`\n* `2017-05-01T21:44-04:00`\n* `2017-05-01T18:44-07:00`\n\n\n[msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads\n[ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601", "required": false, "type": "string" }, { "name": "from_to_status", "in": "query", "description": "This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. \n\nPossible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.", "required": false, "type": "string" }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "Specifies additional information to return about the envelopes.\nUse a comma-separated list, such as `folders, recipients` to specify information.\nValid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: Information about the email settings associated with the envelope.\n- `folders`: The folders where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n" }, { "name": "include_purge_information", "in": "query", "required": false, "type": "string", "description": "When **true,** information about envelopes that have been deleted is included in the response." }, { "name": "intersecting_folder_ids", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of folders that you want want to get envelopes from. Valid values are: \n\n- `normal`\n- `inbox`\n- `sentitems`\n- `draft`\n- `templates`" }, { "name": "last_queried_date", "in": "query", "required": false, "type": "string", "description": "Returns envelopes that were modified prior to the specified date and time. \n\nExample: `2020-05-09T21:56:12.2500000Z`" }, { "name": "order", "in": "query", "required": false, "type": "string", "description": "Returns envelopes in either ascending (`asc`) or descending (`desc`) order." }, { "name": "order_by", "in": "query", "required": false, "type": "string", "description": "Sorts results according to a specific property. Valid values are:\n\n- `last_modified`\n- `action_required`\n- `created`\n- `completed`\n- `envelope_name`\n- `expire`\n- `sent`\n- `signer_list`\n- `status`\n- `subject`\n- `user_name`\n- `status_changed`\n- `last_modified`" }, { "name": "powerformids", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of `PowerFormId` values." }, { "name": "query_budget", "in": "query", "required": false, "type": "string", "description": "The time in seconds that the query should run before returning data." }, { "name": "requester_date_format", "in": "query", "required": false, "type": "string", "description": "" }, { "name": "search_mode", "in": "query", "required": false, "type": "string", "description": "" }, { "name": "search_text", "in": "query", "required": false, "type": "string", "description": "Free text search criteria that you can use to filter the list of envelopes that is returned." }, { "name": "start_position", "in": "query", "required": false, "type": "string", "description": "The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n" }, { "name": "status", "in": "query", "description": "A comma-separated list of current envelope statuses to included in the response. Possible values are:\n\n* `completed`\n* `created`\n* `declined`\n* `deleted`\n* `delivered`\n* `processing`\n* `sent`\n* `signed`\n* `timedout`\n* `voided`\n\nThe `any` value is equivalent to any status.\n", "required": false, "type": "string" }, { "name": "to_date", "in": "query", "description": "Specifies the date and time\nto stop looking for status changes.\nThe default is the current date and time.\n\nAlthough you can use any date format\nsupported by the .NET system library's\n[`DateTime.Parse()`][msoft] function,\nDocuSign recommends\nusing [ISO 8601][] format dates\nwith an explicit time zone offset\nIf you do not provide\na time zone offset,\nthe method uses the server's time zone.\n\nFor example, the following dates and times refer to the same instant:\n\n* `2017-05-02T01:44Z`\n* `2017-05-01T21:44-04:00`\n* `2017-05-01T18:44-07:00`\n\n\n[msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads\n[ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601\n", "required": false, "type": "string" }, { "name": "transaction_ids", "in": "query", "description": "If included in the query string, this is a comma separated list of envelope `transactionId`s. \n\nIf included in the `request_body`, this is a list of envelope `transactionId`s. \n\n###### Note: `transactionId`s are only valid in the DocuSign system for seven days.\n", "required": false, "type": "string" }, { "name": "user_filter", "in": "query", "required": false, "type": "string", "description": "Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid values are:\n\n- `sender`\n- `recipient`\n- `recipient_only`" }, { "name": "user_id", "in": "query", "required": false, "type": "string", "description": "The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account." }, { "name": "user_name", "in": "query", "required": false, "type": "string", "description": "Limit results to envelopes\nsent by the account user\nwith this user name.\n\n`email` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.\n" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopesInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listStatusChanges", "x-ds-method": "listStatusChanges", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "Envelopes" ], "summary": "Creates an envelope.", "description": "Creates and sends an envelope or creates a draft envelope.\nEnvelopes are fundamental resources in the DocuSign platform.\n\n\nWith this method you can:\n\n* Create and send an envelope\n with [documents][], [recipients][], and [tabs][].\n* [Create and send an envelope from a template](/docs/esign-rest-api/esign101/concepts/templates/).\n* [Create and send an envelope from\n a combination of documents and templates](/docs/esign-rest-api/esign101/concepts/templates/composite/).\n* Create a draft envelope.\n\n\nWhen you use this method\nto create and send an envelope\nin a single request,\nthe following parameters in the request body (an [`envelopeDefinition`][envelopeDefinition] object) are required:\n\n| Parameter | Description |\n| :-------- | :---------- |\n| `status` | Set to `sent` to send the envelope to recipients.
Set to `created` (or don't set at all) to save the envelope as a draft. |\n| `emailSubject` | The subject of the email used to send the envelope. |\n| `documents` | The [documents][] to be signed. |\n| `recipients` | The email addresses of the envelope [recipients][]. |\n\n\nWhen you create an envelope by using a\n[composite template](/docs/esign-rest-api/esign101/concepts/templates/composite/),\nyou should specify the envelope custom fields in the inline template.\nAny custom fields that you specify at the root level are ignored.\n\nIf the envelope has a workflow definition\nand the `workflowStatus` is `paused`,\nthe envelope will not be sent immediately,\neven if the envelope's `status` is `sent`.\n\n\n### Related topics\n\n[Envelope][envelopes] and [template][templates]\nobjects along with [documents][documents],\n[recipients][recipients], and [tabs][tabs]\nare the five object models at the core of the eSignature API.\nThe [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/)\ndescribes how the five object models work together.\n\nThe following how-to articles contain\npractical examples that show you how to\nto\nconfigure this method's\n[`envelopeDefinition`][envelopeDefinition] request body\nto perform common tasks.\n\nRequesting a signature\n\n- [How to request a signature by email](/docs/esign-rest-api/how-to/request-signature-email-remote/)\n- [How to request a signature through your app](/docs/esign-rest-api/how-to/request-signature-in-app-embedded/)\n- [How to request a signature by email using a template](/docs/esign-rest-api/how-to/request-signature-template-remote/)\n- [How to request a signature using a composite template](/docs/esign-rest-api/how-to/request-signature-composite-template-embedded/)\n- [How to request a signature by SMS delivery](/docs/esign-rest-api/how-to/request-signature-sms/)\n- [How to send a request for payment](/docs/esign-rest-api/how-to/request-a-payment/)\n- [How to send an envelope to an In Person Signer](/docs/esign-rest-api/how-to/send-envelope-to-in-person-signer/)\n- [How to request a signature through your app (embedded signing) with a CFR Part 11 account](/docs/esign-rest-api/how-to/request-signature-in-app-embedded-cfrpart11/)\n\nWorking with envelopes and templates\n\n- [How to get envelope information](/docs/esign-rest-api/how-to/get-envelope-information/)\n- [How to list envelope recipients](/docs/esign-rest-api/how-to/get-envelope-recipients/)\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)\n- [How to create a template](/docs/esign-rest-api/how-to/create-template/)\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\nWorking with advanced recipient routing\n\n- [How to pause a signature workflow](/docs/esign-rest-api/how-to/pause-workflow/)\n- [How to unpause a signature workflow](/docs/esign-rest-api/how-to/unpause-workflow/)\n- [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/)\n- [How to schedule an envelope](/docs/esign-rest-api/how-to/schedule-an-envelope/)\n- [How to send an envelope with delayed routing](/docs/esign-rest-api/how-to/send-envelope-with-delayed-routing/)\n\nWorking with documents\n\n- [How to list envelope documents](/docs/esign-rest-api/how-to/list-envelope-documents/)\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\n- [How to attach documents via binary transfer](/docs/esign-rest-api/how-to/send-binary/)\n- [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/)\n- [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/)\n- [How to set document visibility for envelope recipients](/docs/esign-rest-api/how-to/set-document-visibility/)\n\nWorking with tabs\n\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\n- [How to get envelope custom tab values](/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)\n- [How to set envelope tab values](/docs/esign-rest-api/how-to/set-envelope-tab-values/)\n- [How to set tab values in a template](/docs/esign-rest-api/how-to/set-template-tab-values/)\n\nWorking with brands\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n- [How to apply a brand to an envelope](/docs/esign-rest-api/how-to/apply-brand-to-envelope/)\n- [How to apply a brand and template to an envelope](/docs/esign-rest-api/how-to/apply-brand-and-template-to-envelope/)\n\nWorking with permissions\n\n- [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)\n- [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)\n- [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)\n- [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)\n\nImplementing multi-factor recipient (signer) authentication\n\n- [How to require ID verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)\n- [How to require knowledge-based authentication (KBA) for a recipient](/docs/esign-rest-api/how-to/knowledge-based-authentication/)\n- [How to require phone authentication for a recipient](/docs/esign-rest-api/how-to/phone-auth/)\n- [How to require access code authentication for a recipient](/docs/esign-rest-api/how-to/require-access-code-recipient/)\n\n\n\n\n\n[addingdocs]: /docs/esign-rest-api/esign101/concepts/envelopes/\n[attachments]: /docs/esign-rest-api/esign101/concepts/documents/attachments/\n[authcopies]: /docs/esign-rest-api/esign101/concepts/documents/authoritative-copies/\n[conoverview]: /docs/esign-rest-api/esign101/concepts/overview/\n[deleting]: /docs/esign-rest-api/esign101/concepts/envelopes/\n[documents]: /docs/esign-rest-api/esign101/concepts/documents/\n[envelopeDefinition]: /docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition\n[envelopes]: /docs/esign-rest-api/esign101/concepts/envelopes/\n[locking]: /docs/esign-rest-api/esign101/concepts/envelopes/lock/\n[payments]: /docs/esign-rest-api/esign101/concepts/tabs/payment/\n[purging]: /docs/esign-rest-api/esign101/concepts/documents/purging/\n[recipients]: /docs/esign-rest-api/esign101/concepts/recipients/\n[recipstatus]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-status\n[reciptypes]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-types\n[supdocs]: /docs/esign-rest-api/esign101/concepts/documents/supplemental/\n[tabanchor]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n[tabcustom]: /docs/esign-rest-api/esign101/concepts/tabs/custom-tabs/\n[tabs]: /docs/esign-rest-api/esign101/concepts/tabs/\n[tabtypes]: /docs/esign-rest-api/esign101/concepts/tabs/\n[templates]: /docs/esign-rest-api/esign101/concepts/templates/\n[tracking]: /docs/esign-rest-api/esign101/concepts/envelopes/\n\n", "operationId": "Envelopes_PostEnvelopes", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "cdse_mode", "in": "query", "required": false, "type": "string", "description": "Reserved for DocuSign.\n" }, { "name": "change_routing_order", "in": "query", "required": false, "type": "string", "description": "When true, users can define the routing order of recipients while sending documents for signature." }, { "name": "completed_documents_only", "in": "query", "description": "Reserved for DocuSign.\n", "required": false, "type": "string" }, { "name": "merge_roles_on_draft", "in": "query", "description": "When **true,** template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.)\n\n**Note:** DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.", "required": false, "type": "string" }, { "name": "envelopeDefinition", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeDefinition" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeSummary" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createEnvelope", "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true, "x-ds-examples": [ { "description": "This example shows a request/response that includes:\n\n* A single PDF document to be signed\n* One tab positioned using anchor text\n* One recipient\n", "direction": "both", "format": "json", "response": { "envelopeId": "63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80", "status": "sent", "statusDateTime": "2016-05-29T17:11:56.1800000Z", "uri": "/envelopes/63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80" }, "request": { "documents": [ { "documentBase64": "[Document content (PDF File)]", "documentId": "1", "fileExtension": "pdf", "name": "NDA.pdf" } ], "emailSubject": "Please sign the NDA", "recipients": { "signers": [ { "email": "the_nda_signer@example.com", "name": "Darlene Petersen", "recipientId": "1", "routingOrder": "1", "tabs": { "dateSignedTabs": [ { "anchorString": "signer1date", "anchorYOffset": "-6", "fontSize": "Size12", "name": "Date Signed", "recipientId": "1", "tabLabel": "date_signed" } ], "fullNameTabs": [ { "anchorString": "signer1name", "anchorYOffset": "-6", "fontSize": "Size12", "name": "Full Name", "recipientId": "1", "tabLabel": "Full Name" } ], "signHereTabs": [ { "anchorString": "signer1sig", "anchorUnits": "mms", "anchorXOffset": "0", "anchorYOffset": "0", "name": "Please sign here", "optional": "false", "recipientId": "1", "scaleValue": 1, "tabLabel": "signer1sig" } ] } } ] }, "status": "sent" }, "style": "custom", "title": "Request Signature on Single Document by Email" }, { "description": "This example shows a request/response that includes:\n\n* Multiple documents, both pdf and Word docx files.\n* Multiple tabs including signing, fullName, dateSigned, and text tabs.\n* Tabs positioned using anchor text.\n* Two recipients, a signer and a cc recipient.\n", "direction": "both", "format": "json", "response": { "envelopeId": "63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80", "status": "sent", "statusDateTime": "2016-05-29T17:11:56.1800000Z", "uri": "/envelopes/63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80" }, "request": { "documents": [ { "documentBase64": "[Document 1 content (PDF File)]", "documentId": "1", "fileExtension": "pdf", "name": "NDA.pdf" }, { "documentBase64": "[Document 2 content (PDF File)]", "documentId": "2", "fileExtension": "pdf", "name": "House.pdf" }, { "documentBase64": "[Document 3 content (Word file)]", "documentId": "3", "fileExtension": "docx", "name": "contractor_agreement.docx" } ], "emailSubject": "Please sign the house documentation package", "recipients": { "carbonCopies": [ { "email": "cody_vigil@worldwidecorp.example.com", "name": "Cody Vigil", "recipientId": "2", "routingOrder": "2" } ], "signers": [ { "email": "darlene_petersen@newco.example.com", "name": "Darlene Petersen", "recipientId": "1", "routingOrder": "1", "tabs": { "dateSignedTabs": [ { "anchorString": "signer1date", "anchorYOffset": "-6", "fontSize": "Size12", "name": "Date Signed", "recipientId": "1", "tabLabel": "date_signed" }, { "documentId": "2", "fontSize": "Size12", "name": "Date Signed", "pageNumber": "1", "recipientId": "1", "tabLabel": "doc3_date_signed", "xPosition": "89", "yPosition": "100" } ], "fullNameTabs": [ { "anchorString": "signer1name", "anchorYOffset": "-6", "fontSize": "Size12", "name": "Full Name", "recipientId": "1", "tabLabel": "Full Name" } ], "signHereTabs": [ { "anchorString": "signer1sig", "anchorUnits": "mms", "anchorXOffset": "0", "anchorYOffset": "0", "name": "Please sign here", "optional": "false", "recipientId": "1", "scaleValue": 1, "tabLabel": "signer1sig" }, { "documentId": "2", "name": "Please sign here", "optional": "false", "pageNumber": "1", "recipientId": "2", "scaleValue": 1, "tabLabel": "signer1_doc2", "xPosition": "89", "yPosition": "40" }, { "anchorString": "Client Signature", "anchorUnits": "mms", "anchorXOffset": "0", "anchorYOffset": "-4", "name": "Please sign here", "optional": "false", "recipientId": "1", "scaleValue": 1, "tabLabel": "doc3_client_sig" } ], "textTabs": [ { "anchorString": "signer1company", "anchorYOffset": "-8", "fontSize": "Size12", "name": "Company", "recipientId": "1", "required": "true", "tabLabel": "Company" }, { "anchorString": "Client Name", "anchorYOffset": "-38", "fontSize": "Size12", "name": "Company", "recipientId": "1", "required": "true", "tabLabel": "Company" }, { "documentId": "3", "fontSize": "Size10", "name": "Company", "pageNumber": "1", "recipientId": "1", "required": "true", "tabLabel": "Company", "xPosition": "145", "yPosition": "195" } ] } } ] }, "status": "sent" }, "style": "custom", "title": "Multiple Documents and Tabs, Signer and CC Recipients" }, { "description": "For some documents, one or more signatures must be witnessed by an appointed [notary public](https://en.wikipedia.org/wiki/Notary_public).\n\nDocuSign supports eNotary services for many jurisdictions. This example demonstrates how to send an envelope to be signed by Susan Signer with her signature witnessed by Nancy Notary. You must know the name and email address of the signer and the notary public for a signature to be notarized.\n\nNote that the full legal name of the signer must be used. It will be checked against the signer's government-issued proof of identity by the notary public.\n\nPlease see the [DocuSign eNotary resource page](https://support.docusign.com/s/document-item?bundleId=gko1642535666104&topicId=jiv1635359045452.html) for further information. It lists the jurisdictions participating in the DocuSign eNotary program and additional reference information.\n\nNote that eNotary services are not included with all account types and are **not** included by default with demo/developer sandbox accounts. To enable eNotary service for your sandbox account, contact your DocuSign technical support person or DocuSign customer service.\n\nThe example includes event notification via the Connect service.", "direction": "both", "format": "json", "response": { "envelopeId": "aaaaaaaa-xxxx-xxxx-xxxx-52a86fb94be8", "uri": "/envelopes/aaaaaaaa-xxxx-xxxx-xxxx-52a86fb94be8", "statusDateTime": "2017-06-15T11:02:39.3996430Z", "status": "sent" }, "request": { "emailSubject": "Important agreement for notarized signature", "status": "sent", "recipients": { "inPersonSigners": [ { "recipientId": 1, "email": "susan_signer@gmail.com", "name": "Susan Anne Signer", "routingOrder": 1, "inPersonSigningType": "notary", "notaryHost": { "name": "Nancy Notary", "email": "nancy@notary-svc.com", "recipientId": 2 }, "tabs": { "signHereTabs": [ { "documentId": "1", "optional": "false", "recipientId": "1", "xPosition": "100", "yPosition": "100", "pageNumber": "1", "name": "Please sign here", "tabLabel": "signer1sig" } ] } } ] }, "documents": [ { "documentId": "1", "name": "important document.docx", "fileExtension": "docx", "documentBase64": "[Contents elided]" } ], "eventNotification": { "includeDocumentFields": "false", "envelopeEvents": [ { "envelopeEventStatusCode": "Completed" }, { "envelopeEventStatusCode": "Declined" }, { "envelopeEventStatusCode": "Voided" } ], "url": "https://listener.example.com/docusign_notifications", "requireAcknowledgment": "true", "includeSenderAccountAsCustomField": "true", "loggingEnabled": "true", "includeDocuments": "false", "signMessageWithX509Cert": "true" } }, "style": "custom", "title": "Create a Notarized Signing Recipient" }, { "description": "DocuSign enables document signers to use\nelectronic or\ndigital signatures.\n\nDocuSign has tightly integrated standard digital signatures into the DocuSign Signature platform. This enables a single envelope to include:\n\n* electronic signatures,\n* AES digital signatures using certificates from DocuSign or from your organization,\n* QES digital signatures from government certified Trust Service Providers (TSPs).\n\nThis example enables the signer to create an eIDAS compliant AES signature with embedded signing. InPerson signers can also use SBS digital signatures.\n\n[More information on creating SBS digital signature requests.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)\n\nThe `clientId` in the example tells DocuSign that the Signing Ceremony will be embedded.\nThe example also includes an `eventNotification` object for receiving envelope status updates from DocuSign.\n\n## Embedding the signing ceremony\n1. Send the `Envelopes: create` call as shown below in the Request/Response section.\n2. The response will include the `envelopeId`\n3. Use the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) request to obtain the redirectURL as follows:\n\n`POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient`\n\n````\n{\n \"clientUserId\": \"1000\",\n \"email\": \"Sam@spade.com\",\n \"userName\": \"Sam Spade\",\n \"returnUrl\": \"https://your_app.example.com\",\n \"AuthenticationMethod\": \"Password\"\n}\n````\nThe response will include the `url`. Redirect the user's browser to the URL to start the signing ceremony.\n\n**Note:** You must **immediately** redirect the user to the URL you receive from DocuSign. The URL is only valid for 5 minutes. Don't request a recipient view URL until you are ready to redirect the user's browser.\n", "direction": "both", "format": "json", "response": { "envelopeId": "caaaaaaa-xxxx-xxxx-xxxx-c171528e99c8", "uri": "/envelopes/caaaaaaa-xxxx-xxxx-xxxx-c171528e99c8", "statusDateTime": "2017-06-22T06:44:49.1642220Z", "status": "sent" }, "request": { "documents": [ { "documentId": "1", "name": " Agreement", "fileExtension": "html", "documentBase64": "[Contents elided]" } ], "emailSubject": "NewCo agreement for signature", "status": "sent", "recipients": { "signers": [ { "recipientId": "1", "clientUserId": "1000", "email": "Sam@spade.com", "name": "Sam Spade", "recipientSignatureProviders": [ { "signatureProviderName": "UniversalSignaturePen_OpenTrust_Hash_TSP", "signatureProviderOptions": { "SMS": "+33134567899" } } ], "routingOrder": "1", "tabs": { "signHereTabs": [ { "documentId": "1", "optional": "false", "recipientId": "1", "name": "Please sign here", "tabLabel": "signer1sig", "anchorString": "signer1sig" } ] } } ] }, "eventNotification": { "includeDocumentFields": "false", "envelopeEvents": [ { "envelopeEventStatusCode": "Completed" }, { "envelopeEventStatusCode": "Declined" }, { "envelopeEventStatusCode": "Voided" } ], "url": "https://your_app.example.com/listener", "requireAcknowledgment": "true", "includeSenderAccountAsCustomField": "true", "loggingEnabled": "true", "includeDocuments": "false", "signMessageWithX509Cert": "true" } }, "style": "custom", "title": "Request an SBS digital signature, with an embedded signing ceremony" } ] }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}": { "get": { "tags": [ "Envelopes" ], "summary": "Gets the status of a single envelope.", "description": "Retrieves the overall status for the specified envelope.\nTo get the status of a list of envelopes, use\n[Envelope: listStatusChanges ](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/).\n\n### Related topics\n\n- [How to get envelope information](/docs/esign-rest-api/how-to/get-envelope-information/)\n", "operationId": "Envelopes_GetEnvelope", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "advanced_update", "in": "query", "description": "When **true,** envelope information can be added or modified.", "required": false, "type": "string" }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: The email settings associated with the envelope.\n- `folders`: The folder where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `powerform`: The PowerForms associated with the envelope.\n- `tabs`: The tabs associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n- `workflow`: The workflow definition associated with the envelope.\n" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelope" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getEnvelope", "x-ds-method": "get", "x-ds-service": "Envelopes", "x-ds-in-sdk": true, "x-ds-examples": [ { "description": "This example shows a how to get information about\nan envelope with a given envelope id.\n\nThe request for this endpoint has no payload.\n\n### Request\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6\n```\n", "direction": "response", "format": "json", "response": { "allowMarkup": "false", "autoNavigation": "true", "brandId": "56502fe1-xxxx-xxxx-xxxx-97cb5c43176a", "certificateUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/certificate", "createdDateTime": "2016-10-05T01:04:58.1830000Z", "customFieldsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/custom_fields", "documentsCombinedUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/combined", "documentsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents", "emailSubject": "Please sign the NDA", "enableWetSign": "true", "envelopeId": "4b728be4-xxxx-xxxx-xxxx-d63e23f822b6", "envelopeIdStamping": "true", "envelopeUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6", "initialSentDateTime": "2016-10-05T01:04:58.7770000Z", "is21CFRPart11": "false", "isSignatureProviderEnvelope": "false", "lastModifiedDateTime": "2016-10-05T01:04:58.1830000Z", "notificationUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/notification", "purgeState": "unpurged", "recipientsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/recipients", "sentDateTime": "2016-10-05T01:04:58.7770000Z", "status": "sent", "statusChangedDateTime": "2016-10-05T01:04:58.7770000Z", "templatesUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/templates" }, "request": null, "style": "custom", "title": "Get Status About a Specific Envelope" } ] }, "put": { "tags": [ "Envelopes" ], "summary": "Send, void, or modify a draft envelope. Purge documents from a completed envelope.", "description": "This method enables you to make changes to an envelope.\nYou can use it to:\n\n* [Send a draft envelope](#sending-a-draft-envelope)\n* [Void an in-process envelope](#voiding-an-in-process-envelope)\n* [Modify a draft envelope](#modifying-envelope-email-information)\n* [Purge documents and envelope metadata from the DocuSign platform](#purging-documents-from-docusign)\n\nAlthough the request body for this method\nis a complete envelope definition,\nyou only need to provide\nthe properties that\nyou're updating.\n\n## Sending a draft envelope\n\nTo send a draft envelope, include the following code in the request body:\n\n```json\n{\n \"status\": \"sent\"\n}\n```\n\nYou can attach a workflow before sending the envelope:\n\n```json\n{\n \"status\": \"sent\",\n \"workflow\": {\n \"workflowSteps\": [\n {\n \"action\": \"pause_before\",\n \"description\": \"pause_before routing order 2\",\n \"itemId\": 2,\n \"triggerOnItem\": \"routing_order\"\n }\n ]\n }\n}\n```\n\n## Working with workflows\n\nTo unpause a workflow, the request body should include this:\n\n```json\n{\n \"workflow\": {\n \"workflowStatus\": \"in_progress\"\n }\n}\n```\n\n## Voiding an in-process envelope\n\nTo void an in-process envelope, include the following code in the request body:\n\n```json\n{\n \"status\": \"voided\",\n \"voidedReason\": \"The reason for voiding the envelope\"\n}\n```\n\n## Modifying envelope email information\n\nTo change the email subject and message of a draft envelope,\ninclude the following code in the request body:\n\n```json\n{\n \"emailSubject\": \"new email subject\",\n \"emailBlurb\": \"new email message\"\n}\n```\n\n## Purging documents from DocuSign\n\nTo place only the documents\nin the purge queue,\nleaving any\ncorresponding attachments\nand tabs in the DocuSign platform,\nset the `purgeState` property\nto `documents_queued`.\n\n```json\n{\n \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n \"purgeState\": \"documents_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue,\nset the `purgeState` property\nto `documents_and_metadata_queued`.\n\n```json\n{\n \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n \"purgeState\": \"documents_and_metadata_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue\nand to redact personal information,\nset the `purgeState` property\nto `documents_and_metadata_and_redact_queued`.\n\n```json\n{\n \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n \"purgeState\": \"documents_and_metadata_and_redact_queued\"\n}\n```\n\nYou can purge documents\nonly from completed envelopes\nthat are not marked as the authoritative copy.\nThe user requesting the purge\nmust have permission to purge documents\nand\nmust be the sender or be acting on behalf of the sender.\n\nWhen the purge request is initiated\nthe items to be purged\nare placed in the purge queue\nfor deletion in 14 days.\nThe sender\nand\nall recipients with DocuSign accounts\nassociated with the envelope\nget an email notification\nthe documents will be deleted in 14 days.\nThe notification contains a link\nto the documents.\nA second email notification\nis sent 7 days later.\nAt the end of the 14-day period\nthe documents are deleted from the system.\nRecipients without DocuSign accounts\ndo not receive email notifications.\n\nIf your account has a Document Retention policy,\nenvelope documents\nare automatically placed\nin the purge queue,\nand notification emails are sent\nat the end of the retention period.\nSetting a Document Retention policy is the same as setting a\nschedule for purging documents.\n\n## Removing documents from the purge queue\n\nTo remove documents from the purge queue, include the following code in the request body:\n\n```json\n{\n \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n \"purgeState\": \"documents_dequeued\"\n}\n```\n\n### Related topics\n\n- [Void an envelope](https://www.docusign.com/blog/dsdev-common-api-tasks-void-an-envelope) ([Common API Tasks](https://www.docusign.com/blog/tags/common-api-tasks))\n- [Purging documents (eSignature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n- [How to unpause a signature workflow](/docs/esign-rest-api/how-to/unpause-workflow/)\n", "operationId": "Envelopes_PutEnvelope", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "advanced_update", "in": "query", "description": "When **true,** allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.", "required": false, "type": "string" }, { "name": "resend_envelope", "in": "query", "description": "When **true,**\nsends the specified envelope again.", "required": false, "type": "string" }, { "name": "envelope", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelope" }, "description": "A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeUpdateSummary" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "update", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments": { "get": { "tags": [ "EnvelopeAttachments" ], "summary": "Returns a list of envelope attachments associated with a specified envelope.", "operationId": "Attachments_GetAttachments", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeAttachmentsResult" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getAttachments", "x-ds-api-status": "beta", "description": "Returns a list of envelope attachments associated with a specified envelope.\n\n\n\n\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo get a list of user-visible attachments,\nuse [EnvelopeDocuments: get](/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/).\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n\n\n\n", "x-ds-method": "list", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeAttachments" ], "summary": "Adds one or more envelope attachments to a draft or in-process envelope.", "operationId": "Attachments_PutAttachments", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "envelopeAttachmentsRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeAttachmentsRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeAttachmentsResult" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "putAttachments", "x-ds-api-status": "beta", "description": "Adds one or more envelope attachments to a draft or in-process envelope.\nEach envelope can have a maximum of 12 attachments.\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/s/document-item?bundleId=gbo1643332197980&topicId=xln1578456261162.html).\n\n\n\n\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n\n\n\n\n\n", "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeAttachments" ], "summary": "Deletes one or more envelope attachments from a draft envelope.", "operationId": "Attachments_DeleteAttachments", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "envelopeAttachmentsRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeAttachmentsRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeAttachmentsResult" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteAttachments", "x-ds-api-status": "beta", "description": "Deletes one or more envelope attachments from a draft envelope.\n\n\n\n\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n\n\n\n", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}": { "get": { "tags": [ "EnvelopeAttachments" ], "summary": "Retrieves an envelope attachment from an envelope.", "operationId": "Attachments_GetAttachment", "consumes": [], "produces": [ "application/octet-stream" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "attachmentId", "in": "path", "required": true, "type": "string", "description": "The unique identifier for the attachment." }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "type": "file" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getAttachment", "x-ds-api-status": "beta", "description": "Retrieves an envelope attachment from an envelope.\n\n\n\n\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n\n\n\n", "x-ds-method": "get", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeAttachments" ], "summary": "Updates an envelope attachment in a draft or in-process envelope.", "operationId": "Attachments_PutAttachment", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "attachmentId", "in": "path", "required": true, "type": "string", "description": "The unique identifier for the attachment." }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "attachment", "in": "body", "required": false, "schema": { "$ref": "#/definitions/attachment" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeAttachmentsResult" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "putAttachment", "x-ds-api-status": "beta", "description": "Updates an envelope attachment to a draft or in-process envelope.\n\n\n\n\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n\n\n\n", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events": { "get": { "tags": [ "Envelopes" ], "summary": "Gets the envelope audit events for an envelope.", "description": "Gets the envelope audit events for the specified envelope.", "operationId": "AuditEvents_GetAuditEvents", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeAuditEventResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listAuditEvents", "x-ds-method": "listAuditEvents", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript": { "get": { "tags": [ "Comments" ], "summary": "Gets a PDF transcript of all of the comments in an envelope.", "operationId": "Comments_GetCommentsTranscript", "consumes": [], "produces": [ "application/pdf" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "encoding", "in": "query", "required": false, "type": "string", "description": "(Optional) The encoding to use for the file." } ], "responses": { "200": { "description": "Successful response.", "schema": { "type": "file" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields": { "get": { "tags": [ "EnvelopeCustomFields" ], "summary": "Gets the custom field information for the specified envelope.", "description": "Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.\n\n\n### Related topics\n\n- [How to get envelope custom tab values](/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)\n", "operationId": "CustomFields_GetCustomFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/customFieldsEnvelope" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listCustomFields", "x-ds-method": "list", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeCustomFields" ], "summary": "Updates envelope custom fields in an envelope.", "description": "Updates the envelope custom fields in draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name.\n", "operationId": "CustomFields_PutCustomFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "EnvelopeCustomFields", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeCustomFields" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeCustomFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateCustomFields", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeCustomFields" ], "summary": "Creates envelope custom fields for an envelope.", "description": "Updates the envelope custom fields for draft and in-process envelopes.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n", "operationId": "CustomFields_PostCustomFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "EnvelopeCustomFields", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeCustomFields" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeCustomFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createCustomFields", "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeCustomFields" ], "summary": "Deletes envelope custom fields for draft and in-process envelopes.", "description": "Deletes envelope custom fields for draft and in-process envelopes.", "operationId": "CustomFields_DeleteCustomFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "EnvelopeCustomFields", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeCustomFields" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeCustomFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteCustomFields", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields": { "get": { "tags": [ "DocumentGeneration" ], "summary": "Returns form fields for an envelope", "operationId": "DocGenFormFields_GetEnvelopeDocGenFormFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/docGenFormFieldResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getEnvelopeDocGenFormFields", "x-ds-method": "getEnvelopeDocGenFormFields", "x-ds-service": "Uncategorized", "description": "Given an `envelopeId` this method\nreturns the form fields found in\nthat envelope's documents.\n\nThe response for envelope that has one document\nwith form fields would look like this:\n\n```json\n{\n \"docGenFormFields\": [\n {\n \"documentId\": \"2dc54cf5-xxxx-xxxx-xxxx-05132a2dd889\",\n \"docGenFormFieldList\": [\n {\n \"label\": \"Candidate_Name\",\n \"type\": \"TextBox\",\n \"required\": \"True\",\n \"name\": \"Candidate_Name\"\n },\n {\n \"label\": \"Job_Title\",\n \"type\": \"TextBox\",\n \"required\": \"True\",\n \"name\": \"Job_Title\"\n },\n {\n \"label\": \"Manager_Name\",\n \"type\": \"TextBox\",\n \"required\": \"True\",\n \"name\": \"Manager_Name\"\n },\n {\n \"label\": \"Start_Date\",\n \"type\": \"TextBox\",\n \"required\": \"True\",\n \"name\": \"Start_Date\"\n },\n {\n \"label\": \"Salary\",\n \"type\": \"TextBox\",\n \"required\": \"True\",\n \"name\": \"Salary\"\n }\n ],\n \"docGenDocumentStatus\": \"created\"\n }\n ]\n}\n```\n\n### Related topics\n\n- [Document generation](/docs/esign-rest-api/esign101/concepts/documents/document-generation/) in the eSignature concepts guide\n- [How to request a signature by email with document generation](/docs/esign-rest-api/how-to/request-signature-email-document-generation/)\n- [Document Generation for DocuSign eSignature](https://support.docusign.com/s/document-item?bundleId=als1679428547895&topicId=ldx1679428689631.html) in the eSignature User Guide", "x-ds-in-sdk": true }, "put": { "tags": [ "DocumentGeneration" ], "summary": "Updates form fields for an envelope.", "operationId": "DocGenFormFields_PutEnvelopeDocGenFormFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "update_docgen_formfields_only", "in": "query", "required": false, "type": "string", "description": "When **true,** only the form fields are updated.\nWhen **false** or omitted,\nthe documents are updated as well." }, { "name": "docGenFormFieldRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/docGenFormFieldRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/docGenFormFieldResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateEnvelopeDocGenFormFields", "x-ds-method": "updateEnvelopeDocGenFormFields", "x-ds-service": "Uncategorized", "description": "This method updates the form fields\nfor all the documents in a given\nenvelope.\n\nThe envelope must be in the `draft` state.\n\n\nThe request body for an envelope that has one document\nwith form fields would look like this:\n\n```json\n{\n \"docGenFormFields\": [\n {\n \"documentId\": \"2dc54cf5-xxxx-xxxx-xxxx-05132a2dd889\",\n \"docGenFormFieldList\": [\n {\n \"name\": \"Candidate_Name\",\n \"value\": \"Peggy Olson\"\n },\n {\n \"name\": \"Job_Title\",\n \"value\": \"Copywriter\"\n },\n {\n \"name\": \"Manager_Name\",\n \"value\": \"Donald Draper\"\n },\n {\n \"name\": \"Start_Date\",\n \"value\": \"March 15, 1960\"\n },\n {\n \"name\": \"Salary\",\n \"value\": \"8000\"\n }\n ]\n }\n ]\n}\n```\n\n### Related topics\n\n- [Document generation](/docs/esign-rest-api/esign101/concepts/documents/document-generation/) in the eSignature concepts guide\n- [How to request a signature by email with document generation](/docs/esign-rest-api/how-to/request-signature-email-document-generation/)\n- [Document Generation for DocuSign eSignature](https://support.docusign.com/s/document-item?bundleId=als1679428547895&topicId=ldx1679428689631.html) in the eSignature User Guide", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents": { "get": { "tags": [ "EnvelopeDocuments" ], "summary": "Gets a list of documents in an envelope.", "description": "Retrieves a list of documents associated with the specified envelope.\n\n### Related topics\n\n- [How to list envelope documents](/docs/esign-rest-api/how-to/list-envelope-documents/)\n", "operationId": "Documents_GetDocuments", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "documents_by_userid", "in": "query", "required": false, "type": "string", "description": "When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders." }, { "name": "include_docgen_formfields", "in": "query", "required": false, "type": "string", "description": "Reserved for DocuSign." }, { "name": "include_metadata", "in": "query", "required": false, "type": "string", "description": "When **true,** the response includes metadata that indicates which properties the sender can edit." }, { "name": "include_tabs", "in": "query", "required": false, "type": "string", "description": "When **true,** information about the tabs, including prefill tabs, associated with the documents are included in the response." }, { "name": "recipient_id", "in": "query", "required": false, "type": "string", "description": "Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this to work." }, { "name": "shared_user_id", "in": "query", "required": false, "type": "string", "description": "The ID of a shared user that you want to impersonate in order to\nretrieve their view of the list of documents. This parameter is\nused in the context of a shared inbox (i.e., when you share\nenvelopes from one user to another through the DocuSign Admin console)." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeDocumentsResult" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listDocuments", "x-ds-method": "list", "x-ds-service": "Envelopes", "x-ds-in-sdk": true, "x-ds-examples": [ { "description": "This example shows how\nto get a list\nof all the documents in an envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents\n```\n", "direction": "response", "format": "json", "response": { "envelopeDocuments": [ { "availableDocumentTypes": [ { "isDefault": "true", "type": "electronic" } ], "display": "inline", "documentId": "1", "includeInDownload": "true", "name": "NDA.pdf", "order": "1", "pages": "3", "signerMustAcknowledge": "no_interaction", "type": "content", "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/1" }, { "availableDocumentTypes": [ { "isDefault": "true", "type": "electronic" } ], "display": "inline", "documentId": "2", "includeInDownload": "true", "name": "House.pdf", "order": "2", "pages": "1", "signerMustAcknowledge": "no_interaction", "type": "content", "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/2" }, { "availableDocumentTypes": [ { "isDefault": "true", "type": "electronic" } ], "display": "inline", "documentId": "3", "includeInDownload": "true", "name": "contractor_agreement.docx", "order": "3", "pages": "2", "signerMustAcknowledge": "no_interaction", "type": "content", "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3" }, { "availableDocumentTypes": [ { "isDefault": "true", "type": "electronic" } ], "display": "inline", "documentId": "certificate", "includeInDownload": "true", "name": "Summary", "order": "999", "pages": "4", "signerMustAcknowledge": "no_interaction", "type": "summary", "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/certificate" } ], "envelopeId": "44efc9e6-xxxx-xxxx-xxxx-801410d6922d" }, "request": null, "style": "custom", "title": "List All Documents in an Envelope" } ] }, "put": { "tags": [ "EnvelopeDocuments" ], "summary": "Adds one or more documents to an existing envelope.", "description": "Adds one or more documents to an existing envelope.\nThe tabs of the original document will be applied to the new document.\n\n\n**Note:** When adding or modifying documents for an in-process envelope,\nDocuSign recommends\n[locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nprior to making any changes.\n\nIf the file name of a document contains Unicode characters, you need to include a `Content-Disposition` header. Example:\n\n\n**Header:** `Content-Disposition`\n\n\n**Value:** `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`", "operationId": "Documents_PutDocuments", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "envelopeDefinition", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeDefinition" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeDocumentsResult" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateDocuments", "x-ds-method": "updateList", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeDocuments" ], "summary": "Deletes documents from a draft envelope.", "description": "Deletes one or more documents from an existing envelope that has not yet been completed.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n\n```text\n{\n \"documents\": [\n {\n \"documentId\": \"1\"\n }\n ]\n}\n```\n\nThe envelope status must be one of:\n\n- `created`\n- `sent`\n- `delivered`\n\n\n", "operationId": "Documents_DeleteDocuments", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "envelopeDefinition", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeDefinition" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeDocumentsResult" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteDocuments", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}": { "get": { "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", "operationId": "Documents_GetDocument", "consumes": [], "produces": [ "application/pdf" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "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).", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "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", "required": false, "type": "string" }, { "name": "documents_by_userid", "in": "query", "required": false, "type": "string", "description": "When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders." }, { "name": "encoding", "in": "query", "required": false, "type": "string", "description": "Reserved for DocuSign." }, { "name": "encrypt", "in": "query", "description": "When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.", "required": false, "type": "string" }, { "name": "language", "in": "query", "description": "Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). ", "required": false, "type": "string" }, { "name": "recipient_id", "in": "query", "required": false, "type": "string", "description": "Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this functionality to work." }, { "name": "shared_user_id", "in": "query", "required": false, "type": "string", "description": "The ID of a shared user that you want to impersonate in order to\nretrieve their view of the list of documents. This parameter is\nused in the context of a shared inbox (i.e., when you share\nenvelopes from one user to another through the DocuSign Admin console)." }, { "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.", "required": false, "type": "string" }, { "name": "watermark", "in": "query", "description": "When **true,** the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark. ", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "type": "file" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getDocument", "x-ds-method": "get", "x-ds-service": "Envelopes", "x-ds-in-sdk": true, "x-ds-examples": [ { "description": "This example shows how to retrieve\na single document from an envelope\nas a PDF file.\n\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3\n```\n\n", "direction": "response", "format": "json", "response": "A byte stream representing a PDF file.", "request": null, "style": "custom", "title": "Get a Single Document as a PDF File" }, { "description": "If you use `combined` instead of a document id\nthe response is a PDF file that contains\nall of the documents in the specified envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/combined\n```\n\n", "direction": "response", "format": "json", "response": "A byte stream representing a PDF file.", "request": null, "style": "custom", "title": "Get All Documents as a Single PDF File" }, { "description": "This example shows how\nto get a list\nof all the documents in an envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents\n```\n", "direction": "response", "format": "json", "response": { "envelopeDocuments": [ { "availableDocumentTypes": [ { "isDefault": "true", "type": "electronic" } ], "display": "inline", "documentId": "1", "includeInDownload": "true", "name": "NDA.pdf", "order": "1", "pages": "3", "signerMustAcknowledge": "no_interaction", "type": "content", "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/1" }, { "availableDocumentTypes": [ { "isDefault": "true", "type": "electronic" } ], "display": "inline", "documentId": "2", "includeInDownload": "true", "name": "House.pdf", "order": "2", "pages": "1", "signerMustAcknowledge": "no_interaction", "type": "content", "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/2" }, { "availableDocumentTypes": [ { "isDefault": "true", "type": "electronic" } ], "display": "inline", "documentId": "3", "includeInDownload": "true", "name": "contractor_agreement.docx", "order": "3", "pages": "2", "signerMustAcknowledge": "no_interaction", "type": "content", "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3" }, { "availableDocumentTypes": [ { "isDefault": "true", "type": "electronic" } ], "display": "inline", "documentId": "certificate", "includeInDownload": "true", "name": "Summary", "order": "999", "pages": "4", "signerMustAcknowledge": "no_interaction", "type": "summary", "uri": "/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/certificate" } ], "envelopeId": "44efc9e6-xxxx-xxxx-xxxx-801410d6922d" }, "request": null, "style": "custom", "title": "List All Documents in an Envelope" } ] }, "put": { "tags": [ "EnvelopeDocuments" ], "summary": "Adds or replaces a document in an existing envelope.", "description": "Adds or replaces a document in an existing draft or in-process envelope.\nAn in-process envelope is one that has been sent but not yet completed or voided.\n\n\n**Note:** When adding or modifying documents for an in-process envelope,\nDocuSign recommends\n[locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nprior to making any changes.\n\nTo add a new document, set the `documentId` path parameter to a new document ID.\n\nTo replace a document, set the `documentId` path parameter to the document ID of the existing document.\nThe tabs of the original document will be applied to the new document.\nFor example, a request in cURL looks like this:\n\n```\n$ curl --location --request PUT 'https://demo.docusign.net/restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1' \\\n --header 'Authorization: Bearer eyJ...bqg' \\\n --header 'Content-Disposition: filename=\"newDocument\"' \\\n --header 'Content-Type: application/pdf' \\\n --data-binary '@/location/of/document.pdf'\n```\n", "operationId": "Documents_PutDocument", "consumes": [ "application/pdf" ], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "documentFileBytes", "in": "body", "description": "Updated document content.", "required": true, "schema": { "format": "binary", "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeDocument" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateDocument", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields": { "get": { "tags": [ "EnvelopeDocumentFields" ], "summary": "Gets the custom document fields from an existing envelope document.", "description": "Retrieves the custom document field information from an existing envelope document.", "operationId": "DocumentFields_GetDocumentFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeDocumentFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listDocumentFields", "x-ds-method": "list", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeDocumentFields" ], "summary": "Updates existing custom document fields in an existing envelope document.", "description": "Updates existing custom document fields in an existing envelope document.", "operationId": "DocumentFields_PutDocumentFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "EnvelopeDocumentFields", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeDocumentFields" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeDocumentFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateDocumentFields", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeDocumentFields" ], "summary": "Creates custom document fields in an existing envelope document.", "description": "Creates custom document fields in an existing envelope document.", "operationId": "DocumentFields_PostDocumentFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "EnvelopeDocumentFields", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeDocumentFields" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeDocumentFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createDocumentFields", "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeDocumentFields" ], "summary": "Deletes custom document fields from an existing envelope document.", "description": "Deletes custom document fields from an existing envelope document.", "operationId": "DocumentFields_DeleteDocumentFields", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "EnvelopeDocumentFields", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeDocumentFields" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeDocumentFields" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteDocumentFields", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions": { "get": { "tags": [ "EnvelopeDocumentHtmlDefinitions" ], "summary": "Retrieves the HTML definition used to generate a dynamically sized responsive document.", "operationId": "ResponsiveHtml_GetEnvelopeDocumentHtmlDefinitions", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The GUID of the document.\n\nExample: c671747c-xxxx-xxxx-xxxx-4a4a48e23744", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentHtmlDefinitionOriginals" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getEnvelopeDocumentHtmlDefinitions", "description": "Retrieves the HTML definition used to generate a dynamically sized responsive document.\n\nIf the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body. \n\n**Note:** The `documentId` query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body.\n\n### Related topics\n\n- [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)", "x-ds-method": "get", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages": { "get": { "tags": [ "Envelopes" ], "summary": "Returns document page images based on input.", "operationId": "Pages_GetPageImages", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "count", "in": "query", "required": false, "type": "string", "description": "The maximum number of results to return." }, { "name": "dpi", "in": "query", "required": false, "type": "string", "description": "The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94." }, { "name": "max_height", "in": "query", "required": false, "type": "string", "description": "Sets the maximum height of the returned images in pixels." }, { "name": "max_width", "in": "query", "required": false, "type": "string", "description": "Sets the maximum width of the returned images in pixels." }, { "name": "nocache", "in": "query", "required": false, "type": "string", "description": "When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value. " }, { "name": "show_changes", "in": "query", "required": false, "type": "string", "description": "When **true,** changes display in the user interface." }, { "name": "start_position", "in": "query", "required": false, "type": "string", "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/pageImages" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}": { "delete": { "tags": [ "Envelopes" ], "summary": "Deletes a page from a document in an envelope.", "description": "Deletes a page from a document in an envelope based on the page number.", "operationId": "Pages_DeletePage", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "pageNumber", "in": "path", "description": "The page number being accessed.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteDocumentPage", "x-ds-method": "deleteDocumentPage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image": { "get": { "tags": [ "Envelopes" ], "summary": "Gets a page image from an envelope for display.", "description": "Returns an image of a page in a document for display.", "operationId": "Pages_GetPageImage", "consumes": [], "produces": [ "image/png" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "pageNumber", "in": "path", "description": "The page number being accessed.", "required": true, "type": "string" }, { "name": "dpi", "in": "query", "description": "Sets the dots per inch (DPI) for the returned image.", "required": false, "type": "string" }, { "name": "max_height", "in": "query", "description": "Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.", "required": false, "type": "string" }, { "name": "max_width", "in": "query", "description": "Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.", "required": false, "type": "string" }, { "name": "show_changes", "in": "query", "required": false, "type": "string", "description": "When **true,** changes display in the user interface." } ], "responses": { "200": { "description": "Successful response.", "schema": { "type": "file" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getDocumentPageImage", "x-ds-method": "getPageImage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "Envelopes" ], "summary": "Rotates page image from an envelope for display.", "description": "Rotates page image from an envelope for display. The page image can be rotated to the left or right.", "operationId": "Pages_PutPageImage", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "pageNumber", "in": "path", "description": "The page number being accessed.", "required": true, "type": "string" }, { "name": "pageRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/pageRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "rotateDocumentPage", "x-ds-method": "rotateDocumentPage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs": { "get": { "tags": [ "EnvelopeDocumentTabs" ], "summary": "Returns tabs on the specified page.", "operationId": "Tabs_GetPageTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "pageNumber", "in": "path", "description": "The page number being accessed.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeDocumentTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview": { "post": { "tags": [ "DocumentResponsiveHtmlPreview" ], "summary": "Creates a preview of the responsive version of a document.", "operationId": "ResponsiveHtml_PostDocumentResponsiveHtmlPreview", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "documentHtmlDefinition", "in": "body", "required": false, "schema": { "$ref": "#/definitions/documentHtmlDefinition" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentHtmlDefinitions" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs": { "get": { "tags": [ "EnvelopeDocumentTabs" ], "summary": "Returns the tabs on a document.", "operationId": "Tabs_GetDocumentTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "include_metadata", "in": "query", "required": false, "type": "string", "description": "When **true,** the response includes metadata indicating which properties are editable." }, { "name": "page_numbers", "in": "query", "required": false, "type": "string", "description": "Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.\n\nExample: `page_numbers=2,6`\n\nNote: You can only enter individual page numbers, and not a page range." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeDocumentTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeDocumentTabs" ], "summary": "Updates the tabs for document.", "operationId": "Tabs_PutDocumentTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "tabs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/tabs" }, "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/tabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateDocumentTabs", "description": "Updates tabs in the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n\n\nThis method operates only on\nsmartSection\nand\npolyLineOverlay\ntabs.\n\n", "x-ds-method": "update", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeDocumentTabs" ], "summary": "Adds tabs to a document in an envelope.", "operationId": "Tabs_PostDocumentTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "tabs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/tabs" }, "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/tabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createDocumentTabs", "description": "Adds tabs to the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n\n\nThis method operates only on\nsmartSection\nand\npolyLineOverlay\ntabs.\n\n", "x-ds-method": "create", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeDocumentTabs" ], "summary": "Deletes tabs from a document in an envelope.", "operationId": "Tabs_DeleteDocumentTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "tabs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/tabs" }, "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/tabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates": { "get": { "tags": [ "EnvelopeTemplates" ], "summary": "Gets the templates associated with a document in an existing envelope.", "description": "Retrieves the templates associated with a document in the specified envelope.", "operationId": "Templates_GetDocumentTemplates", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "A comma-separated list that limits the results.\nValid values are:\n\n* `applied`\n* `matched`\n" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/templateInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listTemplatesForDocument", "x-ds-method": "listByDocument", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeTemplates" ], "summary": "Adds templates to a document in an envelope.", "description": "Adds templates to a document in the specified envelope.", "operationId": "Templates_PostDocumentTemplates", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "preserve_template_recipient", "in": "query", "required": false, "type": "string", "description": "If omitted or set to false (the default),\nenvelope recipients _will be removed_\nif the template being applied\nincludes only tabs positioned via anchor text for the recipient,\nand none of the documents include the anchor text. \n\nWhen **true,** the recipients _will be preserved_ after the template is applied.\n\n" }, { "name": "documentTemplateList", "in": "body", "required": false, "schema": { "$ref": "#/definitions/documentTemplateList" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentTemplateList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "applyTemplateToDocument", "x-ds-method": "applyToDocument", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}": { "delete": { "tags": [ "EnvelopeTemplates" ], "summary": "Deletes a template from a document in an existing envelope.", "description": "Deletes the specified template from a document in an existing envelope.", "operationId": "Templates_DeleteDocumentTemplates", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "documentId", "in": "path", "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "templateId", "in": "path", "description": "The ID of the template.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteTemplatesFromDocument", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings": { "get": { "tags": [ "EnvelopeEmailSettings" ], "summary": "Gets the email setting overrides for an envelope.", "description": "Retrieves the email override settings for the specified envelope.", "operationId": "EmailSettings_GetEmailSettings", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/emailSettings" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getEmailSettings", "x-ds-method": "get", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeEmailSettings" ], "summary": "Updates the email setting overrides for an envelope.", "description": "Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.\n\nThis can also be used to delete an individual email override setting by using an empty string for the value to be deleted.", "operationId": "EmailSettings_PutEmailSettings", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "emailSettings", "in": "body", "required": false, "schema": { "$ref": "#/definitions/emailSettings" }, "description": "A complex type that contains email settings." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/emailSettings" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateEmailSettings", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeEmailSettings" ], "summary": "Adds email setting overrides to an envelope.", "description": "Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.\n\nThe BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes.\nTo send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery recipient type.\n\n**Note:** DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. ", "operationId": "EmailSettings_PostEmailSettings", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "emailSettings", "in": "body", "required": false, "schema": { "$ref": "#/definitions/emailSettings" }, "description": "A complex type that contains email settings." } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/emailSettings" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createEmailSettings", "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeEmailSettings" ], "summary": "Deletes the email setting overrides for an envelope.", "description": "Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.", "operationId": "EmailSettings_DeleteEmailSettings", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/emailSettings" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteEmailSettings", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data": { "get": { "tags": [ "EnvelopeFormData" ], "summary": "Returns envelope tab data for an existing envelope.", "operationId": "FormData_GetFormData", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeFormData" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions": { "get": { "tags": [ "EnvelopeHtmlDefinitions" ], "summary": "Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.", "operationId": "ResponsiveHtml_GetEnvelopeHtmlDefinitions", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentHtmlDefinitionOriginals" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getEnvelopeHtmlDefinitions", "description": "", "x-ds-method": "list", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock": { "get": { "tags": [ "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", "operationId": "Lock_GetEnvelopeLock", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeLocks" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getLock", "x-ds-method": "get", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeLocks" ], "summary": "Updates an envelope lock.", "description": "Updates the lock information for a locked 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\n\nUse this method to change the duration\nof the lock (`lockDurationInSeconds`)\nor the `lockedByApp` string.\n\nThe request body is a full `lockRequest` object,\nbut you only need to specify the\nproperties that you are updating. For example:\n\n```\n{\n \"lockDurationInSeconds\": \"3600\",\n \"lockedByApp\": \"My Application\"\n}\n```\n\n", "operationId": "Lock_PutEnvelopeLock", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "lockRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/lockRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeLocks" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateLock", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "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", "operationId": "Lock_PostEnvelopeLock", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "lockRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/lockRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeLocks" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createLock", "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ "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", "operationId": "Lock_DeleteEnvelopeLock", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeLocks" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteLock", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification": { "get": { "tags": [ "Envelopes" ], "summary": "Gets envelope notification information.", "description": "Retrieves the envelope notification, reminders and expirations, information for an existing envelope.", "operationId": "Notification_GetEnvelopesEnvelopeIdNotification", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/notification" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getNotificationSettings", "x-ds-method": "getNotificationSettings", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "Envelopes" ], "summary": "Sets envelope notifications for an existing envelope.", "operationId": "Notification_PutEnvelopesEnvelopeIdNotification", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "envelopeNotificationRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeNotificationRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/notification" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients": { "get": { "tags": [ "EnvelopeRecipients" ], "summary": "Gets the status of recipients for an envelope.", "description": "Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values.\n\nThe `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.\n\n### Related topics\n\n- [How to list envelope recipients](/docs/esign-rest-api/how-to/get-envelope-recipients/)\n", "operationId": "Recipients_GetRecipients", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "include_anchor_tab_locations", "in": "query", "description": " When **true** and `include_tabs` value is set to **true,** all tabs with anchor tab properties are included in the response. ", "required": false, "type": "string" }, { "name": "include_extended", "in": "query", "description": " When **true,** the extended properties are included in the response. ", "required": false, "type": "string" }, { "name": "include_metadata", "in": "query", "required": false, "type": "string", "description": "Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates)." }, { "name": "include_tabs", "in": "query", "description": "When **true,** the tab information associated with the recipient is included in the response.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipients" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listRecipients", "x-ds-method": "list", "x-ds-service": "Envelopes", "x-ds-in-sdk": true, "x-ds-examples": [ { "description": "This example shows the result of an envelope\nwith one signer and a CC'ed recipient.\n\n\n### Request\nThe request for this endpoint has no payload.\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/recipients\n```\n\n\n", "direction": "response", "format": "json", "response": { "agents": [], "carbonCopies": [ { "email": "aoneil@example.com", "name": "Ariana O'Neill", "recipientId": "2", "recipientIdGuid": "72edf9b6-xxxx-xxxx-xxxx-86bc5d598bb8", "requireIdLookup": "false", "routingOrder": "2", "status": "completed", "userId": "b72bd827-xxxx-xxxx-xxxx-64ab32f0a0eb" } ], "certifiedDeliveries": [], "currentRoutingOrder": "1", "editors": [], "inPersonSigners": [], "intermediaries": [], "recipientCount": "2", "signers": [ { "deliveredDateTime": "2016-10-05T21:18:12.3330000Z", "email": "jallard@example.com", "isBulkRecipient": "false", "name": "Jennie Allard", "recipientId": "1", "recipientIdGuid": "4575d5e9-xxxx-xxxx-xxxx-6c59ca7c43f8", "requireIdLookup": "false", "routingOrder": "1", "signedDateTime": "2016-10-05T21:18:41.6930000Z", "status": "completed", "userId": "ca45284a-xxxx-xxxx-xxxx-76035bd795b2" } ] }, "request": null, "style": "custom", "title": "List Recipients and CC-ed Recipients" }, { "description": "This example shows the method's response after the envelope was signed.\n\nThe signer recipient successfully authenticated using:\n* An access code (a pre-shared secret between the sender and the signer)\n* Authentication via Facebook. The Facebook email address is recorded in the Certificate of Completion\n", "direction": "response", "format": "json", "response": { "agents": [], "carbonCopies": [], "certifiedDeliveries": [], "currentRoutingOrder": "1", "editors": [], "inPersonSigners": [], "intermediaries": [], "recipientCount": "1", "signers": [ { "accessCode": "1234", "deliveredDateTime": "2016-07-11T06:19:36.4200000Z", "email": "larry@example.com", "idCheckConfigurationName": "Facebook", "isBulkRecipient": "false", "name": "Larry Smithers", "recipientAuthenticationStatus": { "accessCodeResult": { "eventTimestamp": "2016-07-11T06:18:55.7170000Z", "status": "Passed" }, "facebookResult": { "eventTimestamp": "2016-07-11T06:19:28.3170000Z", "status": "Passed" } }, "recipientId": "1", "recipientIdGuid": "9670e679-xxxx-xxxx-xxxx-02b43027cb0a", "requireIdLookup": "true", "routingOrder": "1", "signInEachLocation": "false", "signedDateTime": "2016-07-11T06:19:44.7470000Z", "status": "completed", "userId": "57a7b68f-xxxx-xxxx-xxxx-381042d14ca5" } ] }, "request": null, "style": "custom", "title": "List Recipients Who Used Facebook and Access Code Authentication" } ] }, "put": { "tags": [ "EnvelopeRecipients" ], "summary": "Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.", "description": "Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope.\n\nIf you send information for a recipient that does not already\nexist in a draft envelope, the recipient is added to the envelope\n(similar to the [EnvelopeRecipients: Create][EnvelopeRecipients-create] method).\n\nYou can also use this method to resend an envelope to a recipient\nby using the `resend_envelope` option.\n\n**Updating Sent Envelopes**\n\nAfter an envelope has been sent, you can edit only the following properties:\n\n- `accessCode`\n- `agentCanEditName`\n- `agentCanEditEmail`\n- `customFields`\n- `deliveryMethod`\n- `documentVisibility`\n- `email` (If you provide an email address in this method, it will be treated as a new email address, even if it is exactly the same as the current address. Do not provide an email address if you do not want a correction email sent.)\n- `emailNotification`\n- `idCheckConfigurationName`\n- `identityVerification`\n- `name`\n- `note`\n- `phoneAuthentication`\n- `recipientType` (For this to work, you must also change the recipient object to match the recipient type.)\n- `requireIdLookup`\n- `routingOrder`\n- `routingOrder`\n- `signingGroupId` (You can change this ID to switch to a different signing group and its corresponding set of recipients.)\n- `smsAuthentication`\n- `suppressEmails`\n- `userName`\n\nIf the recipient has signed,\nbut the envelope is still active,\nthe method will return success,\nbut the `recipientUpdateResults` property\nin the response will include an error\nthat the recipient could not be updated:\n\n```\n{\n \"recipientUpdateResults\": [\n {\n \"recipientId\": \"999\",\n \"errorDetails\": {\n \"errorCode\": \"RECIPIENT_UPDATE_FAILED\",\n \"message\": \"The recipient could not be updated. Recipient not in state that allows correction.\"\n }\n }\n ]\n}\n```\n\nIf the envelope is completed,\nand you try to change a recipient's address,\nthe method will fail with this error:\n\n```\n{\n \"errorCode\": \"ENVELOPE_INVALID_STATUS\",\n \"message\": \"Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct.\"\n}\n```\n\n**Note:** This method works on recipients only.\nTo add recipient tabs,\nuse methods from the [EnvelopeRecipientTabs][recipientTabs] resource.\nFor example, this request body will add a recipient (`astanton@example.com`)\nbut **NOT** the Sign Here recipient tab.\n\n```json\n{\n \"signers\": [\n {\n \"email\": \"astanton@example.com\",\n \"name\": \"Anne Stanton\",\n \"recipientId\": \"1\",\n// THIS WILL NOT WORK\n \"tabs\": {\n \"signHereTabs\": [\n {\n \"anchorString\": \"below\",\n \"tooltip\": \"please sign here3\"\n },\n . . .\n ]\n }\n }\n ]\n}\n```\n\n\n[EnvelopeRecipients-create]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/create/\n[recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n\n", "operationId": "Recipients_PutRecipients", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "combine_same_order_recipients", "in": "query", "required": false, "type": "string", "description": "When **true,** recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=fxo1578456612662.html), and is based on Recipient Role and Routing Order." }, { "name": "offline_signing", "in": "query", "required": false, "type": "string", "description": "Indicates if offline signing is enabled for the recipient when a network connection is unavailable. " }, { "name": "resend_envelope", "in": "query", "description": "When **true,**\nforces the envelope to be resent\nif it would not be resent otherwise.\n\nOrdinarily, if the recipient's routing order\nis before or the same as the envelope's next recipient,\nthe envelope is not resent.\n\nSetting this query parameter\nto **false** has no effect and is the same as omitting\nit altogether.\n", "required": false, "type": "string" }, { "name": "EnvelopeRecipients", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeRecipients" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/recipientsUpdateSummary" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateRecipients", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeRecipients" ], "summary": "Adds one or more recipients to an envelope.", "description": "Adds one or more recipients to an envelope.\n\nFor an in-process envelope,\none that has been sent and has not been completed or voided,\nan email is sent to a new recipient\nwhen they are reached in the routing order.\nIf the new recipient's routing order\nis before or the same as the envelope's\nnext recipient,\nan email is only sent if the optional\n`resend_envelope` query string is set to **true.**\n\n\n**Note:** This method works on recipients only.\nTo add recipient tabs,\nuse methods from the [EnvelopeRecipientTabs][recipientTabs] resource.\nFor example, this request body will add a recipient (`astanton@example.com`)\nbut **NOT** the Sign Here recipient tab.\n\n```json\n{\n \"signers\": [\n {\n \"email\": \"astanton@example.com\",\n \"name\": \"Anne Stanton\",\n \"recipientId\": \"1\",\n \"tabs\": { // These tabs will NOT be added\n \"signHereTabs\": [ // with this method. See note above.\n {\n \"anchorString\": \"below\",\n \"tooltip\": \"please sign here\"\n },\n . . .\n ]\n }\n }\n ]\n}\n```\n\n[recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n\n\n", "operationId": "Recipients_PostRecipients", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "resend_envelope", "in": "query", "description": "When **true,**\nforces the envelope to be resent\nif it would not be resent otherwise.\n\nOrdinarily, if the recipient's routing order\nis before or the same as the envelope's next recipient,\nthe envelope is not resent.\n\nSetting this query parameter\nto **false** has no effect and is the same as omitting\nit altogether.\n", "required": false, "type": "string" }, { "name": "EnvelopeRecipients", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeRecipients" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipients" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createRecipient", "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeRecipients" ], "summary": "Deletes recipients from an envelope.", "description": "Deletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the `recipientId` as the key for deleting recipients.\n\nIf the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.", "operationId": "Recipients_DeleteRecipients", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "EnvelopeRecipients", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeRecipients" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipients" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteRecipients", "x-ds-method": "deleteList", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}": { "delete": { "tags": [ "EnvelopeRecipients" ], "summary": "Deletes a recipient from an envelope.", "description": "Deletes a recipient from a `draft` or `sent` envelope.\n\nIf the envelope is \"In Process\" (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted.", "operationId": "Recipients_DeleteRecipient", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipients" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteRecipient", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure": { "get": { "tags": [ "EnvelopeConsumerDisclosures" ], "summary": "Gets the default Electronic Record and Signature Disclosure for an envelope.", "description": "Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify. \n\nThis is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.", "operationId": "ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientId", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "langCode", "in": "query", "required": false, "type": "string", "description": "(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/consumerDisclosure" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getConsumerDisclosureDefault", "x-ds-method": "getDefault", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}": { "get": { "tags": [ "EnvelopeConsumerDisclosures" ], "summary": "Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.", "description": "Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient's language settings.\n\nTo set the language of the disclosure that you want to retrieve, specify the `langCode` as either a path or query parameter.", "operationId": "ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientIdLangCode", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "langCode", "in": "path", "description": "(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "langCode", "in": "query", "required": false, "type": "string", "description": "(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/consumerDisclosure" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getConsumerDisclosure", "x-ds-method": "get", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility": { "get": { "tags": [ "EnvelopeDocumentVisibility" ], "summary": "Returns document visibility for a recipient", "operationId": "Recipients_GetRecipientDocumentVisibility", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentVisibilityList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeDocumentVisibility" ], "summary": "Updates document visibility for a recipient", "operationId": "Recipients_PutRecipientDocumentVisibility", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "documentVisibilityList", "in": "body", "required": false, "schema": { "$ref": "#/definitions/documentVisibilityList" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentVisibilityList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token": { "post": { "tags": [ "EnvelopeRecipients" ], "summary": "Creates a resource token for a sender to request ID Evidence data. ", "operationId": "Recipients_PostRecipientProofFileResourceToken", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The account ID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "The `recipientIdGuid`.", "required": true, "type": "string" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/idEvidenceResourceToken" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image": { "get": { "tags": [ "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.", "operationId": "Recipients_GetRecipientInitialsImage", "consumes": [], "produces": [ "image/gif" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "include_chrome", "in": "query", "description": "The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "type": "file" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getRecipientInitialsImage", "x-ds-method": "getRecipientInitialsImage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "Envelopes" ], "summary": "Sets the initials image for an accountless signer.", "description": "Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false.**", "operationId": "Recipients_PutRecipientInitialsImage", "consumes": [ "image/gif" ], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateRecipientInitialsImage", "x-ds-method": "updateRecipientInitialsImage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature": { "get": { "tags": [ "Envelopes" ], "summary": "Gets signature information for a signer or sign-in-person recipient.", "description": "Retrieves signature information for a signer or sign-in-person recipient.", "operationId": "Recipients_GetRecipientSignature", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/userSignature" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getRecipientSignature", "x-ds-method": "getRecipientSignature", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image": { "get": { "tags": [ "Envelopes" ], "summary": "Retrieve signature image information for a signer/sign-in-person recipient.", "description": "Retrieves the specified user signature image. The image is returned in the same format as 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 don't 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 have chromed images. If getting the non-chromed image fails, try getting the chromed image.", "operationId": "Recipients_GetRecipientSignatureImage", "consumes": [], "produces": [ "image/gif" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "include_chrome", "in": "query", "description": "When **true,** the response includes the chromed version of the signature image.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "type": "file" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getRecipientSignatureImage", "x-ds-method": "getRecipientSignatureImage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "Envelopes" ], "summary": "Sets the signature image for an accountless signer.", "description": "Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false.**", "operationId": "Recipients_PutRecipientSignatureImage", "consumes": [ "image/gif" ], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateRecipientSignatureImage", "x-ds-method": "updateRecipientSignatureImage", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs": { "get": { "tags": [ "EnvelopeRecipientTabs" ], "summary": "Gets the tabs information for a signer or sign-in-person recipient in an envelope.", "description": "Retrieves information about the tabs associated\nwith a recipient. You can make a single API call\nto get all the tab values and information from a\ngiven, completed envelope in addition to draft\nones. Tab values can be retrieved by using the\n[EnvelopeRecipients:list method](/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/)\nwith query parameter `include_tabs` set to **true.**", "operationId": "Recipients_GetRecipientTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "include_anchor_tab_locations", "in": "query", "description": "When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**", "required": false, "type": "string" }, { "name": "include_metadata", "in": "query", "required": false, "type": "string", "description": "When **true,** the response includes metadata indicating which properties are editable." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipientTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listTabs", "x-ds-method": "list", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeRecipientTabs" ], "summary": "Updates the tabs for a recipient.\n\n", "description": "Updates one or more tabs for a recipient in a draft envelope.\nA draft envelope is one that is not yet complete.\n\n**Note:** It is an error to update a tab that has the\n`templateLocked` property set to true.\nThis property corresponds to the **Restrict changes** option in the web app.\n\n", "operationId": "Recipients_PutRecipientTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "EnvelopeRecipientTabs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeRecipientTabs" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipientTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateTabs", "x-ds-method": "update", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeRecipientTabs" ], "summary": "Adds tabs for a recipient.", "description": "Adds one or more tabs for a recipient.", "operationId": "Recipients_PostRecipientTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "EnvelopeRecipientTabs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeRecipientTabs" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipientTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createTabs", "x-ds-method": "create", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeRecipientTabs" ], "summary": "Deletes the tabs associated with a recipient.\n\n**Note:** It is an error to delete a tab that has the\n`templateLocked` property set to true.\nThis property corresponds to the **Restrict changes** option in the web app.\n\n", "description": "Deletes one or more tabs associated with a recipient in a draft envelope.", "operationId": "Recipients_DeleteRecipientTabs", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n", "required": true, "type": "string" }, { "name": "EnvelopeRecipientTabs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeRecipientTabs" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipientTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteTabs", "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review": { "post": { "tags": [ "EnvelopeRecipients" ], "summary": "Create the link to the page for manually reviewing IDs.", "operationId": "Views_PostRecipientManualReviewView", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "A value that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the [AppsI and Keys](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=pmp1583277397015.html) page.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "recipientId", "in": "path", "description": "A GUID value that DocuSign assigns to identify each recipient in an envelope. This value is globally unique for all recipients, not just those in your account.\n\nThe specified recipient must belong to a workflow that allows the [manual review](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=eya1583277454804.html) of IDs. In addition, the status of the automatic verification for this recipient must return `Failed` and the value of the `vendorFailureStatusCode` field must be `MANUAL_REVIEW_STARTED` as shown in the following extract of a response to the [GET ENVELOPE](/docs/esign-rest-api/reference/envelopes/envelopes/get/) method:\n

\n\n```\n\"recipientAuthenticationStatus\": {\n \"identityVerificationResult\": { \n \"status\": \"Failed\",\n \"eventTimestamp\": \"2020-09-04T16:59:42.8045667Z\",\n \"vendorFailureStatusCode\": \"MANUAL_REVIEW_STARTED\"\n }\n }\n```", "required": true, "type": "string" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/viewUrl" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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/s/document-item?bundleId=ced1643229641057&topicId=lyp1578456530647.html) the ID of a recipient. ", "x-ds-method": "createRecipientManualReviewView", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility": { "put": { "tags": [ "EnvelopeDocumentVisibility" ], "summary": "Updates document visibility for recipients", "operationId": "Recipients_PutRecipientsDocumentVisibility", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "documentVisibilityList", "in": "body", "required": false, "schema": { "$ref": "#/definitions/documentVisibilityList" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentVisibilityList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview": { "post": { "tags": [ "ResponsiveHtmlPreview" ], "summary": "Creates a preview of the responsive versions of all of the documents in an envelope.", "operationId": "ResponsiveHtml_PostResponsiveHtmlPreview", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "documentHtmlDefinition", "in": "body", "required": false, "schema": { "$ref": "#/definitions/documentHtmlDefinition" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentHtmlDefinitions" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "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", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob": { "get": { "tags": [ "TabsBlob" ], "summary": "Reserved for DocuSign.", "operationId": "TabsBlob_GetTabsBlob", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getTabsBlob", "description": "This endpoint has been deprecated.", "x-ds-method": "getTabsBlob", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "put": { "tags": [ "TabsBlob" ], "summary": "Reserved for DocuSign.", "operationId": "TabsBlob_PutTabsBlob", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "putTabsBlob", "description": "This endpoint has been deprecated.", "x-ds-method": "putTabsBlob", "x-ds-service": "Uncategorized", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates": { "get": { "tags": [ "EnvelopeTemplates" ], "summary": "Get List of Templates used in an Envelope", "description": "This returns a list of the server-side templates, their name and ID, used in an envelope.\n", "operationId": "Templates_GetEnvelopeTemplates", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "include", "in": "query", "description": "The possible value is `matching_applied`, which returns template matching information for the template.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/templateInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listTemplates", "x-ds-method": "list", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeTemplates" ], "summary": "Adds templates to an envelope.", "description": "Adds templates to the specified envelope.", "operationId": "Templates_PostEnvelopeTemplates", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeId", "in": "path", "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", "required": true, "type": "string" }, { "name": "preserve_template_recipient", "in": "query", "required": false, "type": "string", "description": "If omitted or set to false (the default),\nenvelope recipients _will be removed_\nif the template being applied\nincludes only tabs positioned via anchor text for the recipient,\nand none of the documents include the anchor text. \n\nWhen **true,** the recipients _will be preserved_ after the template is applied.\n\n" }, { "name": "documentTemplateList", "in": "body", "required": false, "schema": { "$ref": "#/definitions/documentTemplateList" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/documentTemplateList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "applyTemplate", "x-ds-method": "apply", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct": { "post": { "tags": [ "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 `