\n%Writing objects...\n4 0 obj\n. . .\n```\n\n(In an actual `curl` request you would use the `--output` switch to\nsave the PDF byte stream into a file.)\n\n### Related topics\n\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\n",
"operationId": "Documents_GetDocument",
"consumes": [],
"produces": [
"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 a PDF file that contains the combined content of all of the documents. If the account option **Attach certification of completion to envelope** is on, then the Certificate of Completion is also included in the PDF file. You set this account option in the Admin tool on the **Signing Settings** screen, or by setting the `attachCompletedEnvelope` property in the `accountSettings` object to **true.**\n- `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the Certificate of Completion.\n- `certificate`: Retrieves the Certificate of Completion as a PDF file.\n",
"required": true,
"type": "string"
},
{
"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": "When **false,** the envelope signing certificate is removed from the download.",
"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. ",
"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. (An in-process envelope is one that has been sent but not yet completed or voided.)\n\nTo replace a document in the envelope, set `documentId` to correspond to the ID of the existing document. Alternatively, to add the document, set `documentId` to a new ID.\n\n**Note:** When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.\n\nThe bytes of the document make up the body of the request. The name of the document is specified in a `Content-Disposition` header. \n\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": [],
"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/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/documentFieldsInformation"
}
},
"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": "documentFieldsInformation",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/documentFieldsInformation"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/documentFieldsInformation"
}
},
"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": "documentFieldsInformation",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/documentFieldsInformation"
},
"description": ""
}
],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/documentFieldsInformation"
}
},
"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": "documentFieldsInformation",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/documentFieldsInformation"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/documentFieldsInformation"
}
},
"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": "Gets the Original HTML Definition used to\ngenerate the Responsive HTML for a given 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 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/documentHtmlDefinitionOriginals"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "getEnvelopeDocumentHtmlDefinitions",
"x-ds-method": "get",
"x-ds-service": "Uncategorized",
"description": "",
"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",
"x-ds-method": "getPageImages",
"x-ds-service": "Envelopes",
"description": "Returns images of the pages in a document for display based on the parameters that you specify.",
"x-ds-in-sdk": true
},
"parameters": []
},
"/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/tabs"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "getPageTabs",
"x-ds-method": "getByPage",
"x-ds-service": "Envelopes",
"description": "Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n",
"x-ds-in-sdk": true
},
"parameters": []
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html": {
"get": {
"tags": [
"DocumentResponsiveHtml"
],
"summary": "Get Responsive HTML for a document in an envelope.",
"operationId": "ResponsiveHtml_GetDocumentResponsiveHtml",
"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_anchor_tab_locations",
"in": "query",
"required": false,
"type": "string",
"description": "When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/documentHtmlDefinitionOriginals"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "getDocumentResponsiveHtml",
"x-ds-method": "getDocumentResponsiveHtml",
"x-ds-service": "Uncategorized",
"description": "",
"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",
"x-ds-method": "create",
"x-ds-service": "Uncategorized",
"description": "Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/)\nHTML version of a specific document.\nThis method enables you to preview a PDF document\nconversion to responsive HTML across device types prior to sending.\n\nThe request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.",
"x-ds-in-sdk": true
},
"parameters": []
},
"/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/tabs"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "getDocumentTabs",
"x-ds-method": "get",
"x-ds-service": "Envelopes",
"description": "Returns the tabs on the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n",
"x-ds-in-sdk": true
},
"put": {
"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",
"x-ds-method": "update",
"x-ds-service": "Uncategorized",
"description": "Updates tabs in the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n",
"x-ds-in-sdk": true
},
"post": {
"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",
"x-ds-method": "create",
"x-ds-service": "Uncategorized",
"description": "Adds tabs to the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n\nIn the request body, you only need to specify the tabs that your\nare adding. For example, to add a text\n[prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs),\nyour request body might look like this:\n\n```\n{\n \"prefillTabs\": {\n \"textTabs\": [\n {\n \"value\": \"a prefill text tab\",\n \"pageNumber\": \"1\",\n \"documentId\": \"1\",\n \"xPosition\": 316,\n \"yPosition\": 97\n }\n ]\n }\n}\n```\n",
"x-ds-in-sdk": true
},
"delete": {
"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",
"x-ds-method": "delete",
"x-ds-service": "Uncategorized",
"description": "Deletes tabs from the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n",
"x-ds-in-sdk": true
},
"parameters": []
},
"/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",
"x-ds-method": "get",
"x-ds-service": "Envelopes",
"description": "This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.\n\n**Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account.\n\n### Related topics\n\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\n",
"x-ds-in-sdk": true
},
"parameters": []
},
"/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",
"x-ds-method": "list",
"x-ds-service": "Uncategorized",
"description": "",
"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",
"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/lockInformation"
}
},
"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/lockInformation"
}
},
"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\n**Note:** To use this method, the envelope locking\ncapability must be enabled for the user; that is, the user setting\n`canLockEnvelopes` must be set to **true.**\n\nThe response to this request includes a `lockToken` parameter\nthat you must use in the `X-DocuSign-Edit` header for\nevery PUT method (typically a method that updates an envelope)\nwhile the envelope is locked.\n\n\nIf you do not provide the `lockToken` when accessing\na locked envelope, you will get the following\nerror:\n\n```\n{\n \"errorCode\": \"EDIT_LOCK_NOT_LOCK_OWNER\",\n \"message\": \"The user is not the owner of the lock. The template is locked by another user or in another application\"\n}\n```\n\n\n### The X-DocuSign-Edit header\n\nThe `X-DocuSign-Edit` header looks like this\nand can be specified in either JSON or XML.\n\n**JSON**\n```\n{\n \"LockToken\": \"token-from-response\",\n \"LockDurationInSeconds\": \"600\"\n}\n```\n\n**XML**\n```\n\n token-from-response\n 600\n\n```\n\nIn the actual HTTP header, you would remove the linebreaks:\n\n```\nX-DocuSign-Edit: {\"LockToken\": \"token-from-response\", \"LockDurationInSeconds\": \"600\" }\n or\nX-DocuSign-Edit:token-from-response600\n```\n\n\n",
"operationId": "Lock_PostEnvelopeLock",
"consumes": [],
"produces": [],
"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/lockInformation"
}
},
"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 paramter\nthat lets you specify whether\nchanges made while the envelope was locked\nare kept or discarded.\n\n\n| Query Parameter | Description |\n| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `save_changes` | (Optional) When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the envelope was locked are discarded. |",
"operationId": "Lock_DeleteEnvelopeLock",
"consumes": [],
"produces": [],
"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/lockInformation"
}
},
"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",
"x-ds-method": "updateNotificationSettings",
"x-ds-service": "Envelopes",
"description": "This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.\n\nNote that this request only specifies when notifications are sent; it does not initiate sending of email messages.",
"x-ds-in-sdk": true
},
"parameters": []
},
"/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/recipients"
}
},
"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/en/guides/ndse-user-guide-manage-automatic-template-matching), 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": "recipients",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/recipients"
},
"description": "An array of recipient objects that provides details about the recipients of the envelope."
}
],
"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": "recipients",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/recipients"
},
"description": "An array of recipient objects that provides details about the recipients of the envelope."
}
],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/recipients"
}
},
"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": "recipients",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/recipients"
},
"description": "An array of recipient objects that provides details about the recipients of the envelope."
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/recipients"
}
},
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/recipients"
}
},
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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",
"x-ds-method": "get",
"x-ds-service": "Envelopes",
"description": "This method returns information about document visibility for a recipient.",
"x-ds-in-sdk": true
},
"put": {
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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",
"x-ds-method": "update",
"x-ds-service": "Envelopes",
"description": "This method updates document visibility for a recipient.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.",
"x-ds-in-sdk": true
},
"parameters": []
},
"/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/proofServiceResourceToken"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "createRecipientProofFileResourceToken",
"x-ds-api-status": "beta",
"x-ds-method": "createRecipientProofFileResourceToken",
"x-ds-service": "Uncategorized",
"description": "Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).",
"x-ds-in-sdk": true
},
"parameters": []
},
"/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` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.",
"operationId": "Recipients_GetRecipientInitialsImage",
"consumes": [],
"produces": [
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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/tabs"
}
},
"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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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": "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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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": "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 that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"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": "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/en/guides/ndse-admin-guide-api-and-keys) 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/en/guides/Identity-Verification-DocuSign-eSignature-Admin-Guide) of IDs. In addition, the status of the automatic verification for this recipient must return `Failed` and the value of the `vendorFailureStatusCode` field must be `MANUAL_REVIEW_STARTED` as shown in the following extract of a response to the [GET ENVELOPE](/docs/esign-rest-api/reference/envelopes/envelopes/get/) method:\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",
"x-ds-method": "createRecipientManualReviewView",
"x-ds-service": "Uncategorized",
"description": "This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient. ",
"x-ds-in-sdk": true
},
"parameters": []
},
"/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",
"x-ds-method": "updateRecipientsDocumentVisibility",
"x-ds-service": "EnvelopeDocumentVisibility",
"description": "This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.",
"x-ds-in-sdk": true
},
"parameters": []
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html": {
"get": {
"tags": [
"ResponsiveHtml"
],
"summary": "Get Responsive HTML for all documents in an envelope.",
"operationId": "ResponsiveHtml_GetResponsiveHtml",
"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",
"required": false,
"type": "string",
"description": "When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/documentHtmlDefinitionOriginals"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "getResponsiveHtml",
"x-ds-method": "getResponsiveHtml",
"x-ds-service": "Uncategorized",
"description": "",
"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",
"x-ds-method": "create",
"x-ds-service": "Uncategorized",
"description": "Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents in an\nenvelope. This method enables you to preview the\nPDF document conversions to responsive HTML across\ndevice types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.\n",
"x-ds-in-sdk": true
},
"parameters": []
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob": {
"get": {
"tags": [
"TabsBlob"
],
"summary": "Gets encrypted tabs for envelope.",
"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",
"x-ds-method": "getTabsBlob",
"x-ds-service": "Uncategorized",
"description": "",
"x-ds-in-sdk": true
},
"put": {
"tags": [
"TabsBlob"
],
"summary": "Updates encrypted tabs for envelope.",
"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",
"x-ds-method": "putTabsBlob",
"x-ds-service": "Uncategorized",
"description": "",
"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\nview of the DocuSign UI in your applications.\n\nThe returned URL can only be redirected to immediately after it\nis generated. It can only be used once. Therefore, request the\nURL immediately before you redirect your user to it.\n\nDue to screen space issues,\ndo not use an `