initial_access: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.
each_access: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable timeframe.
offrequired_fieldsrequired_and_blank_fieldsall_fieldspage_then_required_fieldspage_then_required_and_blank_fieldspage_then_all_fieldsonce: Per account, the supplemental document is displayed once only per userId. always: Per envelope, the supplemental document is displayed once only per userId. each_access: - Per envelope, the supplemental document is displayed once only per recipientId. document: Tabs in a document with the same label populate with the same data. envelope: Tabs in all documents in the envelope with the same label populate with the same data. no_restrictions : there are no restrictions on the type of documents that can be uploaded. allow_pdf_only : only: non-administrators can only upload PDF files. no_upload : Non-administrators cannot upload files. none topaz e_padv9 e_pad_integrisign always never variable: Use the value in idCheckExpireDays always never optional: Authentication is determined by the sender. no_sign no_sign_allow_user_override yes_sign none: a Digital Signature certificate is not required. docusign_express: signers must use a DocuSign Express certificate. docusign_personal: signers must use a DocuSign personal certificate. open_trust: signers must use an OpenTrust certificate. include_pdf: A PDF of the completed document is attached to the emailinclude_link: A secure link to the self-signed documents is included in the email.login_not_required: The signer is not required to log on to the system. login_required_if_account_holder: If the signer has a DocuSign account, they must log on to sign the document. login_required_per_session: The sender cannot send an envelope to anyone who does not have a DocuSign account. login_required_per_envelope: The sender cannot send an envelope to anyone who does not have a DocuSign account and the signer must log on the system for each envelope they will sign. \n\nAlthough the request body for this method\nis a complete envelope definition,\nyou only need to provide\nthe properties that\nyou're updating. \n\n
\n**Note**: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.\n\nIf the file name of a document contains unicode characters, you need to include a `Content-Disposition` header. Example:\n\n\n**Header**: `Content-Disposition`\n\n\n**Value**: `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`",
"operationId": "Documents_PutDocuments",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The external account number (int) or account ID GUID.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "envelopeDefinition",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/envelopeDefinition"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocuments"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "updateDocuments",
"x-ds-method": "updateList",
"x-ds-service": "Envelopes",
"x-ds-in-sdk": true
},
"delete": {
"tags": [
"EnvelopeDocuments"
],
"summary": "Deletes documents from a draft envelope.",
"description": "Deletes one or more documents from an existing envelope that has not yet been completed.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n\n```text\n{\n \"documents\": [\n {\n \"documentId\": \"1\"\n }\n ]\n}\n```\n\nThe envelope status must be one of:\n\n- `created`\n- `sent`\n- `delivered`\n\n\n",
"operationId": "Documents_DeleteDocuments",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The external account number (int) or account ID GUID.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "envelopeDefinition",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/envelopeDefinition"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocuments"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "deleteDocuments",
"x-ds-method": "delete",
"x-ds-service": "Envelopes",
"x-ds-in-sdk": true
},
"parameters": []
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}": {
"get": {
"tags": [
"EnvelopeDocuments"
],
"summary": "Gets a document from an envelope.",
"description": "Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted.\n\nThe `{documentID}` parameter takes two special values:\n\n| Value | Description |\n| :--- | :--- |\n| `combined` | Retrieve a PDF that contains the combined content of all documents and the certificate. |\n| `archive` | Retrieve a ZIP archive that contains all of the PDF documents, the certificate, and any .WAV files used for voice authentication. |\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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "certificate",
"in": "query",
"description": "When set to **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 set to **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": ""
},
{
"name": "encrypt",
"in": "query",
"description": "When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.",
"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 retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console)."
},
{
"name": "show_changes",
"in": "query",
"description": "When set to **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 set to **true**, the account has the watermark feature enabled, and the envelope is not complete, 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/1703061/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/3\n```\n\n",
"direction": "response",
"format": "json",
"response": "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/1703061/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/documents/combined\n```\n\n",
"direction": "response",
"format": "json",
"response": "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-915e-4b1d-9b54-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-915e-4b1d-9b54-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-915e-4b1d-9b54-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-915e-4b1d-9b54-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-915e-4b1d-9b54-801410d6922d/documents/certificate"
}
],
"envelopeId": "44efc9e6-915e-4b1d-9b54-801410d6922d"
},
"request": null,
"style": "custom",
"title": "List All Documents in an Envelope"
}
]
},
"put": {
"tags": [
"EnvelopeDocuments"
],
"summary": "Adds a document to an existing draft envelope.",
"description": "Adds a document to an existing draft envelope. The bytes of the document make up the body of the request. \n\n\n\n**Note**: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.\n\n\n\n\nIf the file name of the document contains unicode characters, you need to include a `Content-Disposition` header. Example:\n\n\n**Header**: `Content-Disposition`\n\n\n**Value**: `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`\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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocumentFields"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "listDocumentFields",
"x-ds-method": "list",
"x-ds-service": "Envelopes",
"x-ds-in-sdk": true
},
"put": {
"tags": [
"EnvelopeDocumentFields"
],
"summary": "Updates existing custom document fields in an existing envelope document.",
"description": "Updates existing custom document fields in an existing envelope document.",
"operationId": "DocumentFields_PutDocumentFields",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The external account number (int) or account ID GUID.",
"required": true,
"type": "string"
},
{
"name": "documentId",
"in": "path",
"description": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "EnvelopeDocumentFields",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/EnvelopeDocumentFields"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocumentFields"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "updateDocumentFields",
"x-ds-method": "update",
"x-ds-service": "Envelopes",
"x-ds-in-sdk": true
},
"post": {
"tags": [
"EnvelopeDocumentFields"
],
"summary": "Creates custom document fields in an existing envelope document.",
"description": "Creates custom document fields in an existing envelope document.",
"operationId": "DocumentFields_PostDocumentFields",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The external account number (int) or account ID GUID.",
"required": true,
"type": "string"
},
{
"name": "documentId",
"in": "path",
"description": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "EnvelopeDocumentFields",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/EnvelopeDocumentFields"
},
"description": ""
}
],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocumentFields"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "createDocumentFields",
"x-ds-method": "create",
"x-ds-service": "Envelopes",
"x-ds-in-sdk": true
},
"delete": {
"tags": [
"EnvelopeDocumentFields"
],
"summary": "Deletes custom document fields from an existing envelope document.",
"description": "Deletes custom document fields from an existing envelope document.",
"operationId": "DocumentFields_DeleteDocumentFields",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The external account number (int) or account ID GUID.",
"required": true,
"type": "string"
},
{
"name": "documentId",
"in": "path",
"description": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "EnvelopeDocumentFields",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/EnvelopeDocumentFields"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocumentFields"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "deleteDocumentFields",
"x-ds-method": "delete",
"x-ds-service": "Envelopes",
"x-ds-in-sdk": true
},
"parameters": []
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions": {
"get": {
"tags": [
"EnvelopeDocumentHtmlDefinitions"
],
"summary": "",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocumentHtmlDefinitions"
}
},
"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 image(s) 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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"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": "If **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": "If **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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "pageNumber",
"in": "path",
"description": "The page number being accessed.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocumentTabs"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "getPageTabs",
"x-ds-method": "getByPage",
"x-ds-service": "Envelopes",
"description": "",
"x-ds-in-sdk": true
},
"parameters": []
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview": {
"post": {
"tags": [
"DocumentResponsiveHtmlPreview"
],
"summary": "",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "documentHtmlDefinition",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/documentHtmlDefinition"
},
"description": ""
}
],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/DocumentResponsiveHtmlPreview"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "createDocumentResponsiveHtmlPreview",
"x-ds-method": "create",
"x-ds-service": "Uncategorized",
"description": "",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "page_numbers",
"in": "query",
"required": false,
"type": "string",
"description": "Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.\n\nExample: `page_numbers=2,6`\n\nNote: You can only enter individual page numbers, and not a page range."
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocumentTabs"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "getDocumentTabs",
"x-ds-method": "get",
"x-ds-service": "Envelopes",
"description": "This method returns the tabs associated with a document.",
"x-ds-in-sdk": true
},
"put": {
"tags": [
"EnvelopeDocumentTabs"
],
"summary": "",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "TemplateRecipientTabs",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/TemplateRecipientTabs"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/TemplateRecipientTabs"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "updateDocumentTabs",
"x-ds-method": "updateDocumentTabs",
"x-ds-service": "Uncategorized",
"description": "",
"x-ds-in-sdk": true
},
"post": {
"tags": [
"EnvelopeDocumentTabs"
],
"summary": "",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "TemplateRecipientTabs",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/TemplateRecipientTabs"
},
"description": ""
}
],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/TemplateRecipientTabs"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "createDocumentTabs",
"x-ds-method": "createDocumentTabs",
"x-ds-service": "Uncategorized",
"description": "",
"x-ds-in-sdk": true
},
"delete": {
"tags": [
"EnvelopeDocumentTabs"
],
"summary": "",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "TemplateRecipientTabs",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/TemplateRecipientTabs"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/TemplateRecipientTabs"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "deleteDocumentTabs",
"x-ds-method": "deleteDocumentTabs",
"x-ds-service": "Uncategorized",
"description": "",
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"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/EnvelopeTemplates"
}
},
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"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": "Integer that identifies the document in the envelope.",
"required": true,
"type": "string"
},
{
"name": "envelopeId",
"in": "path",
"description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`",
"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-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeEmailSettings"
}
},
"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-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "EnvelopeEmailSettings",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/EnvelopeEmailSettings"
},
"description": ""
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeEmailSettings"
}
},
"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\n### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.",
"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-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
},
{
"name": "EnvelopeEmailSettings",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/EnvelopeEmailSettings"
},
"description": ""
}
],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeEmailSettings"
}
},
"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-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeEmailSettings"
}
},
"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 form 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-afa0-4adf-933c-f752070d71ec`",
"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 field 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.",
"x-ds-in-sdk": true
},
"parameters": []
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions": {
"get": {
"tags": [
"EnvelopeHtmlDefinitions"
],
"summary": "",
"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-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeDocumentHtmlDefinitions"
}
},
"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\nIf the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This information enables users to recover a lost editing session token and the `X-DocuSign-Edit` header.",
"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-afa0-4adf-933c-f752070d71ec`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeLocks"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"deprecated": false,
"x-ds-methodname": "getLock",
"x-ds-method": "get",
"x-ds-service": "Envelopes",
"x-ds-in-sdk": true
},
"put": {
"tags": [
"EnvelopeLocks"
],
"summary": "Updates an envelope lock.",
"description": "Updates the lock duration or the `lockedByApp` property for the specified envelope. The user must match the user specified by the `lockByUser` property, and the integrator key that you pass in must match the integrator key information. You must also include the `X-DocuSign-Edit` header, which contains a `lockToken` that proves ownership of the lock and the `lockDurationInSeconds`. The token that you need for this header is returned in the response to the POST and GET methods.\n\nExample:\n\n`X-DocuSign-Edit:
\n\n", "operationId": "Views_PostEnvelopeSenderView", "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-afa0-4adf-933c-f752070d71ec`", "required": true, "type": "string" }, { "name": "returnUrlRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/returnUrlRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeViews" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createSenderView", "x-ds-method": "createSender", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared": { "post": { "tags": [ "EnvelopeViews" ], "summary": "", "operationId": "Views_PostEnvelopeRecipientSharedView", "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-afa0-4adf-933c-f752070d71ec`", "required": true, "type": "string" }, { "name": "recipientViewRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/recipientViewRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/TemplateViews" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createEnvelopeRecipientSharedView", "x-ds-method": "createSharedRecipient", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/status": { "put": { "tags": [ "Envelopes" ], "summary": "Gets the envelope status for the specified envelopes.", "description": "Retrieves the envelope status for the specified envelopes.\n\nYou can specify the list of envelopes in the `envelope_ids` query parameter or in the request body as part of a `envelopeIdsRequest` object.", "operationId": "Envelopes_PutStatus", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "ac_status", "in": "query", "required": false, "type": "string", "description": "Specifies the Authoritative Copy Status for the envelopes. The possible values are: \n\n- `Unknown`\n- `Original`\n- `Transferred`\n- `AuthoritativeCopy`\n- `AuthoritativeCopyExportPending`\n- `AuthoritativeCopyExported`\n- `DepositPending`\n- `Deposited`\n- `DepositedEO`\n- `DepositFailed`" }, { "name": "block", "in": "query", "required": false, "type": "string", "description": "If **true** removes any results that match one of the provided `transaction_ids`." }, { "name": "count", "in": "query", "required": false, "type": "string", "description": "The maximum number of results to return." }, { "name": "email", "in": "query", "required": false, "type": "string", "description": "Email address of the sender." }, { "name": "envelope_ids", "in": "query", "required": false, "type": "string", "description": "The envelope IDs to include in the results.\n\nThe value of this property can be:\n- A comma-separated list of envelope IDs\n- The special value `request_body`. In this case, this method uses the envelope IDs in the request body." }, { "name": "from_date", "in": "query", "required": false, "type": "string", "description": "The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are provided. \n\n****Note****: This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified." }, { "name": "from_to_status", "in": "query", "required": false, "type": "string", "description": "The envelope status that you are checking for. Possible values are:\n\n\n- `Changed` (default)\n- `Completed`\n- `Created`\n- `Declined`\n- `Deleted`\n- `Delivered`\n- `Processing`\n- `Sent`\n- `Signed`\n- `TimedOut`\n- `Voided`\n\nFor example, if you specify `Changed`, this method\nreturns a list of envelopes that changed status\nduring the `from_date` to `to_date` time period. \n" }, { "name": "start_position", "in": "query", "required": false, "type": "string", "description": "Starting position for search." }, { "name": "status", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of envelope status to search for. Possible values are:\n\n- `completed`\n- `created`\n- `declined`\n- `deleted`\n- `delivered`\n- `processing`\n- `sent`\n- `signed`\n- `template`\n- `voided`\n" }, { "name": "to_date", "in": "query", "required": false, "type": "string", "description": "Optional date/time setting\nthat specifies the last date/time \nor envelope status changes in the result set. \n\nDefault: \"now\", the time that you call the method. \n" }, { "name": "transaction_ids", "in": "query", "required": false, "type": "string", "description": "The transaction IDs to include in the results. Note that transaction IDs are valid for seven days.\n\nThe value of this property can be:\n- A list of comma-separated transaction IDs\n- The special value `request_body`. In this case, this method uses the transaction IDs in the request body." }, { "name": "user_name", "in": "query", "required": false, "type": "string", "description": "Limit results to envelopes\nsent by the account user\nwith this user name.\n\n`email` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.\n" }, { "name": "envelopeIdsRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeIdsRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopesInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listStatus", "x-ds-method": "listStatus", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/transfer_rules": { "get": { "tags": [ "EnvelopeTransferRules" ], "summary": "", "operationId": "EnvelopeTransferRules_GetEnvelopeTransferRules", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "count", "in": "query", "required": false, "type": "string", "description": "The maximum number of results to return." }, { "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/EnvelopeTransferRules" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getEnvelopeTransferRules", "x-ds-method": "getEnvelopeTransferRules", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopeTransferRules" ], "summary": "", "operationId": "EnvelopeTransferRules_PutEnvelopeTransferRules", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "EnvelopeTransferRules", "in": "body", "required": false, "schema": { "$ref": "#/definitions/EnvelopeTransferRules" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeTransferRules" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateEnvelopeTransferRules", "x-ds-method": "updateEnvelopeTransferRules", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "post": { "tags": [ "EnvelopeTransferRules" ], "summary": "", "operationId": "EnvelopeTransferRules_PostEnvelopeTransferRules", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeTransferRuleRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeTransferRuleRequest" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeTransferRules" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createEnvelopeTransferRules", "x-ds-method": "createEnvelopeTransferRules", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}": { "put": { "tags": [ "EnvelopeTransferRules" ], "summary": "", "operationId": "EnvelopeTransferRules_PutEnvelopeTransferRule", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeTransferRuleId", "in": "path", "required": true, "type": "string", "description": "" }, { "name": "envelopeTransferRule", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopeTransferRule" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeTransferRule" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateEnvelopeTransferRule", "x-ds-method": "updateEnvelopeTransferRule", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "delete": { "tags": [ "EnvelopeTransferRules" ], "summary": "", "operationId": "EnvelopeTransferRules_DeleteEnvelopeTransferRules", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopeTransferRuleId", "in": "path", "required": true, "type": "string", "description": "" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteEnvelopeTransferRules", "x-ds-method": "deleteEnvelopeTransferRules", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/folders": { "get": { "tags": [ "Folders" ], "summary": "Gets a list of the folders for the account.", "description": "Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.", "operationId": "Folders_GetFolders", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of folder types to include in the response.\nValid values are:\n\n- `envelope_folders`: Returns a list of envelope folders. (Default)\n- `template_folders`: Returns a list of template folders. \n- `shared_template_folders`: Returns a list of shared template folders.\n" }, { "name": "include_items", "in": "query", "required": false, "type": "string", "description": "Indicates whether folder items are included in the response. If this parameter is omitted, the default is false." }, { "name": "start_position", "in": "query", "required": false, "type": "string", "description": "The position within the total result set from which to start returning values." }, { "name": "template", "in": "query", "description": "This parameter is deprecated as of version 2.1. Use `include` instead.", "required": false, "type": "string" }, { "name": "user_filter", "in": "query", "required": false, "type": "string", "description": "Narrows down the resulting folder list by the following values:\n\n- `all`: Returns all templates owned or shared with the user. (default)\n- `owned_by_me`: Returns only templates the user owns.\n- `shared_with_me`: Returns only templates that are shared with the user.\n" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/Folders" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "list", "x-ds-method": "list", "x-ds-service": "Folders", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/folders/{folderId}": { "get": { "tags": [ "Folders" ], "summary": "Gets a list of the envelopes in the specified folder.", "description": "Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.", "operationId": "Folders_GetFolderItems", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "folderId", "in": "path", "description": "Unique identifier for the folder.", "required": true, "type": "string" }, { "name": "from_date", "in": "query", "description": "Reserved for DocuSign.", "required": false, "type": "string" }, { "name": "include_items", "in": "query", "required": false, "type": "string", "description": "Indicates whether folder items are included in the response. If this parameter is omitted, the default is false." }, { "name": "owner_email", "in": "query", "description": "Reserved for DocuSign.", "required": false, "type": "string" }, { "name": "owner_name", "in": "query", "description": "Reserved for DocuSign.", "required": false, "type": "string" }, { "name": "search_text", "in": "query", "description": "Reserved for DocuSign.", "required": false, "type": "string" }, { "name": "start_position", "in": "query", "description": "Reserved for DocuSign.", "required": false, "type": "string" }, { "name": "status", "in": "query", "description": "Reserved for DocuSign.", "required": false, "type": "string" }, { "name": "to_date", "in": "query", "description": "Reserved for DocuSign.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/folderItemsResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listItems", "x-ds-method": "listItems", "x-ds-service": "Folders", "x-ds-in-sdk": true }, "put": { "tags": [ "Folders" ], "summary": "Moves an envelope from its current folder to the specified folder.", "description": "Moves an envelope from its current folder to the specified folder.\n\nYou can use this method to delete envelopes by specifying `recyclebin` in the `folderId` parameter.\nPlacing an in-process envelope (envelope status of `sent` or `delivered`) in the recycle bin voids the envelope.\n\nYou can also use this method to delete templates by specifying a template ID instead of an envelope ID in the 'envelopeIds' property and specifying `recyclebin` in the `folderId` parameter. ", "operationId": "Folders_PutFolderById", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "folderId", "in": "path", "description": "Unique identifier for the folder.", "required": true, "type": "string" }, { "name": "foldersRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/foldersRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/Folders" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "moveEnvelopes", "x-ds-method": "moveEnvelopes", "x-ds-service": "Folders", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/groups": { "get": { "tags": [ "Groups" ], "summary": "Gets information about groups associated with the account.", "description": "Retrieves information about groups associated with the account.", "operationId": "Groups_GetGroups", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "count", "in": "query", "description": "Number of records to return. The number must be greater than 1 and less than or equal to 100.", "required": false, "type": "string" }, { "name": "group_type", "in": "query", "required": false, "type": "string", "description": "" }, { "name": "include_usercount", "in": "query", "required": false, "type": "string", "description": "When set to **true**, every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is **true**." }, { "name": "search_text", "in": "query", "required": false, "type": "string", "description": "Filters the results of a GET request based on the text that you specify." }, { "name": "start_position", "in": "query", "description": "The starting value for the list.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/Groups" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listGroups", "x-ds-method": "list", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "put": { "tags": [ "Groups" ], "summary": "Updates the group information for a group.", "description": "Updates the group name and modifies, or sets, the permission profile for the group.", "operationId": "Groups_PutGroups", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "Groups", "in": "body", "required": false, "schema": { "$ref": "#/definitions/Groups" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/Groups" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateGroups", "x-ds-method": "update", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "post": { "tags": [ "Groups" ], "summary": "Creates one or more groups for the account.", "description": "Creates one or more groups for the account.\n\nGroups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.", "operationId": "Groups_PostGroups", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "Groups", "in": "body", "required": false, "schema": { "$ref": "#/definitions/Groups" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/Groups" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createGroups", "x-ds-method": "create", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "delete": { "tags": [ "Groups" ], "summary": "Deletes an existing user group.", "description": "Deletes an existing user group.", "operationId": "Groups_DeleteGroups", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "Groups", "in": "body", "required": false, "schema": { "$ref": "#/definitions/Groups" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/Groups" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteGroups", "x-ds-method": "delete", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/groups/{groupId}/brands": { "get": { "tags": [ "GroupBrands" ], "summary": "Gets group brand ID Information.\n", "description": "Retrieves information about the brands associated with the requested group.", "operationId": "Brands_GetGroupBrands", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "groupId", "in": "path", "description": "The ID of the group being accessed.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/GroupBrands" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getBrands", "x-ds-method": "get", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "put": { "tags": [ "GroupBrands" ], "summary": "Adds group brand ID information to a group.", "description": "Adds group brand ID information to a group.", "operationId": "Brands_PutGroupBrands", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "groupId", "in": "path", "description": "The ID of the group being accessed.", "required": true, "type": "string" }, { "name": "brandsRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/brandsRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/GroupBrands" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateBrands", "x-ds-method": "update", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "delete": { "tags": [ "GroupBrands" ], "summary": "Deletes brand information from the requested group.", "description": "Deletes brand information from the requested group.", "operationId": "Brands_DeleteGroupBrands", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "groupId", "in": "path", "description": "The ID of the group being accessed.", "required": true, "type": "string" }, { "name": "brandsRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/brandsRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/GroupBrands" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteBrands", "x-ds-method": "delete", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/groups/{groupId}/users": { "get": { "tags": [ "GroupUsers" ], "summary": "Gets a list of users in a group.", "description": "Retrieves a list of users in a group.", "operationId": "Groups_GetGroupUsers", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "groupId", "in": "path", "description": "The ID of the group being accessed.", "required": true, "type": "string" }, { "name": "count", "in": "query", "description": "Number of records to return. The number must be greater than 1 and less than or equal to 100. ", "required": false, "type": "string" }, { "name": "start_position", "in": "query", "description": "Starting value for the list.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/GroupUsers" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listGroupUsers", "x-ds-method": "list", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "put": { "tags": [ "GroupUsers" ], "summary": "Adds one or more users to an existing group.", "description": "Adds one or more existing DocuSign users to an existing group.", "operationId": "Groups_PutGroupUsers", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "groupId", "in": "path", "description": "The ID of the group being accessed.", "required": true, "type": "string" }, { "name": "userInfoList", "in": "body", "required": false, "schema": { "$ref": "#/definitions/userInfoList" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/GroupUsers" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateGroupUsers", "x-ds-method": "update", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "delete": { "tags": [ "GroupUsers" ], "summary": "Deletes one or more users from a group", "description": "Deletes one or more users from a group. This request takes a `userInfoList` that contains the users that you want to delete.\n", "operationId": "Groups_DeleteGroupUsers", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "groupId", "in": "path", "description": "The ID of the group being accessed.", "required": true, "type": "string" }, { "name": "userInfoList", "in": "body", "required": false, "schema": { "$ref": "#/definitions/userInfoList" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/GroupUsers" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteGroupUsers", "x-ds-method": "delete", "x-ds-service": "Groups", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/identity_verification": { "get": { "tags": [ "IdentityVerifications" ], "summary": "Retrieves the list of identity verification workflows available to an account", "operationId": "AccountIdentityVerification_GetAccountIdentityVerification", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/IdentityVerifications" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getAccountIdentityVerification", "x-ds-method": "list", "x-ds-service": "Uncategorized", "description": "Retrieves the list of identity verification workflows available to an account", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/payment_gateway_accounts": { "get": { "tags": [ "PaymentGatewayAccounts" ], "summary": "List payment gateway account information", "operationId": "PaymentGatewayAccounts_GetAllPaymentGatewayAccounts", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/paymentGatewayAccountsInfo" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getAllPaymentGatewayAccounts", "x-ds-api-status": "beta", "x-ds-method": "list", "x-ds-service": "Accounts", "description": "List payment gateway account information", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/permission_profiles": { "get": { "tags": [ "AccountPermissionProfiles" ], "summary": "Gets a list of permission profiles.", "description": "This method returns a list of permission profiles that are associated with an account.", "operationId": "PermissionProfiles_GetPermissionProfiles", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of additional properties to return in the response. Valid values are:\n\n- `user_count`: The total number of users associated with the permission profile.\n- `closed_users`: Includes closed users in the `user_count`.\n- `account_management`: The account management settings.\n- `metadata`: Metadata indicating whether the properties associated with the account permission profile are editable.\n\nExample: `user_count,closed_users`\n" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/permissionProfileInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listPermissions", "x-ds-method": "list", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "post": { "tags": [ "AccountPermissionProfiles" ], "summary": "Creates a new permission profile for an account.", "operationId": "PermissionProfiles_PostPermissionProfiles", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." }, { "name": "AccountPermissionProfiles", "in": "body", "required": false, "schema": { "$ref": "#/definitions/AccountPermissionProfiles" }, "description": "Information about the permission profiles associated with an account." } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountPermissionProfiles" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createPermissionProfile", "x-ds-method": "create", "x-ds-service": "Accounts", "description": "This method creates a new permission profile for an account.", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}": { "get": { "tags": [ "AccountPermissionProfiles" ], "summary": "Returns a permission profile for an account.", "operationId": "PermissionProfiles_GetPermissionProfile", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "permissionProfileId", "in": "path", "required": true, "type": "string", "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountPermissionProfiles" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getPermissionProfile", "x-ds-method": "get", "x-ds-service": "Accounts", "description": "This method returns information about a specific permission profile that is associated with an account.", "x-ds-in-sdk": true }, "put": { "tags": [ "AccountPermissionProfiles" ], "summary": "Updates a permission profile.", "operationId": "PermissionProfiles_PutPermissionProfiles", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "permissionProfileId", "in": "path", "required": true, "type": "string", "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." }, { "name": "include", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable." }, { "name": "AccountPermissionProfiles", "in": "body", "required": false, "schema": { "$ref": "#/definitions/AccountPermissionProfiles" }, "description": "Information about the permission profiles associated with an account." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountPermissionProfiles" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updatePermissionProfile", "x-ds-method": "update", "x-ds-service": "Accounts", "description": "This method updates an account permission profile.", "x-ds-in-sdk": true }, "delete": { "tags": [ "AccountPermissionProfiles" ], "summary": "Deletes a permission profile from an account.", "operationId": "PermissionProfiles_DeletePermissionProfiles", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "permissionProfileId", "in": "path", "required": true, "type": "string", "description": "The ID of the permission profile. Possible values include:\n\n- `2301416` (for the `DocuSign Viewer` profile)\n- `2301415` (for the `DocuSign Sender` profile)\n- `2301414` (for the `Account Administrator` profile)\n\nIn addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`." } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deletePermissionProfile", "x-ds-method": "delete", "x-ds-service": "Accounts", "description": "This method deletes a permission profile from an account.", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/powerforms": { "get": { "tags": [ "PowerForms" ], "summary": "Returns a list of PowerForms.", "operationId": "PowerForms_GetPowerFormsList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "from_date", "in": "query", "required": false, "type": "string", "description": "(Optional) The start date for a date range.\n\n**Note**: If no value is provided, no date filtering is applied." }, { "name": "order", "in": "query", "required": false, "type": "string", "description": "(Optional) The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. " }, { "name": "order_by", "in": "query", "required": false, "type": "string", "description": "(Optional) The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`" }, { "name": "to_date", "in": "query", "required": false, "type": "string", "description": "(Optional) The end date for a date range.\n\n**Note**: If no value is provided, this property defaults to the current date." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/powerFormsResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listPowerForms", "x-ds-method": "list", "x-ds-service": "PowerForms", "description": "This method returns a list of PowerForms that are available to the user.", "x-ds-in-sdk": true }, "post": { "tags": [ "PowerForms" ], "summary": "Creates a new PowerForm.", "operationId": "PowerForms_PostPowerForm", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "PowerForms", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PowerForms" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/PowerForms" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createPowerForm", "x-ds-method": "create", "x-ds-service": "PowerForms", "description": "This method creates a new PowerForm. \n\nYou create a PowerForm from an existing DocuSign [template](https://developers.docusign.com/esign-rest-api/reference/Templates/Templates/create), based on the `templateId` in the request body.\n\n PowerForms that you create from a template are referred to as web PowerForms. \n\n**Note**: The RADmin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API.\n\n**Note**: A PowerForm can have only one sender. If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.\n\n\n\n### Signing Modes\n\nYou can use one of the following signing modes for a PowerForm:\n \n**`email`**\n\nThis mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.\n\nAlternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.\n\nExample: `activateonly=1`\n\n**`direct`**\n\nThis mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing**, a new browser tab opens and the recipient can immediately begin the signing process.\n\nBecause the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). \n\n**Note**: In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.", "x-ds-in-sdk": true }, "delete": { "tags": [ "PowerForms" ], "summary": "Deletes one or more PowerForms.", "operationId": "PowerForms_DeletePowerFormsList", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "powerFormsRequest", "in": "body", "required": false, "schema": { "$ref": "#/definitions/powerFormsRequest" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/powerFormsResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deletePowerForms", "x-ds-method": "deleteList", "x-ds-service": "PowerForms", "description": "This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/powerforms/{powerFormId}": { "get": { "tags": [ "PowerForms" ], "summary": "Returns a single PowerForm.", "operationId": "PowerForms_GetPowerForm", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "powerFormId", "in": "path", "required": true, "type": "string", "description": "The id of the PowerForm." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/PowerForms" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getPowerForm", "x-ds-method": "get", "x-ds-service": "PowerForms", "description": "This method returns detailed information about a specific PowerForm.", "x-ds-in-sdk": true }, "put": { "tags": [ "PowerForms" ], "summary": "Updates an existing PowerForm.", "operationId": "PowerForms_PutPowerForm", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "powerFormId", "in": "path", "required": true, "type": "string", "description": "The id of the PowerForm." }, { "name": "PowerForms", "in": "body", "required": false, "schema": { "$ref": "#/definitions/PowerForms" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/PowerForms" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updatePowerForm", "x-ds-method": "update", "x-ds-service": "PowerForms", "description": "This method updates an existing PowerForm.", "x-ds-in-sdk": true }, "delete": { "tags": [ "PowerForms" ], "summary": "Deletes a PowerForm.", "operationId": "PowerForms_DeletePowerForm", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "powerFormId", "in": "path", "required": true, "type": "string", "description": "The id of the PowerForm." } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deletePowerForm", "x-ds-method": "delete", "x-ds-service": "PowerForms", "description": "This method deletes a PowerForm.", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data": { "get": { "tags": [ "PowerFormData" ], "summary": "Returns the data that users entered in a PowerForm.", "operationId": "PowerForms_GetPowerFormFormData", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "powerFormId", "in": "path", "required": true, "type": "string", "description": "The id of the PowerForm." }, { "name": "data_layout", "in": "query", "required": false, "type": "string", "description": "The layout in which to return the PowerForm data. Valid values are:\n\n- `Native`\n- `Csv_Classic`\n- `Csv_One_Envelope_Per_Line`\n- `Xml_Classic`" }, { "name": "from_date", "in": "query", "required": false, "type": "string", "description": "The start date for a date range in UTC DateTime format.\n\n**Note**: If this property is null, no date filtering is applied." }, { "name": "to_date", "in": "query", "required": false, "type": "string", "description": "The end date of a date range in UTC DateTime format. The default value is `UtcNow`." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/powerFormsFormDataResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getPowerFormData", "x-ds-method": "list", "x-ds-service": "PowerForms", "description": "This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.\n\nYou specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values:\n\n\n- `application/json`: JSON format\n- `application/xml`: XML format\n- `text/csv`: Comma-separated value (CSV) format\n\n**Note**: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/powerforms/senders": { "get": { "tags": [ "PowerForms" ], "summary": "Gets PowerForm senders.", "operationId": "PowerForms_GetPowerFormsSenders", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "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/powerFormSendersResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listPowerFormSenders", "x-ds-method": "listSenders", "x-ds-service": "PowerForms", "description": "This method returns a list of users who have sent PowerForms.", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/recipient_names": { "get": { "tags": [ "Accounts" ], "summary": "Gets recipient names associated with an email address.", "description": "Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.", "operationId": "RecipientNames_GetRecipientNames", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "email", "in": "query", "description": "The email address for the user", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/recipientNamesResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listRecipientNamesByEmail", "x-ds-method": "listRecipientNamesByEmail", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/seals": { "get": { "tags": [ "AccountSealProviders" ], "summary": "", "operationId": "AccountSignatureProviders_GetSealProviders", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountSealProviders" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getSealProviders", "x-ds-method": "list", "x-ds-service": "TrustServiceProviders", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/search_folders/{searchFolderId}": { "get": { "tags": [ "Folders" ], "summary": "Gets a list of envelopes in folders matching the specified criteria.", "description": "**This method is deprecated in API v2.1.**\n\nUse [Envelopes::listStatusChanges](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges) instead.\n\nRetrieves a list of items that match the criteria specified in the query.\n\nIf the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.", "operationId": "SearchFolders_GetSearchFolderContents", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "searchFolderId", "in": "path", "description": "Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.", "required": true, "type": "string" }, { "name": "all", "in": "query", "description": "Specifies that all envelopes that match the criteria are returned.", "required": false, "type": "string" }, { "name": "count", "in": "query", "description": "Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.", "required": false, "type": "string" }, { "name": "from_date", "in": "query", "description": "Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.", "required": false, "type": "string" }, { "name": "include_recipients", "in": "query", "description": "When set to **true**, the recipient information is returned in the response.", "required": false, "type": "string" }, { "name": "order", "in": "query", "description": "Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.", "required": false, "type": "string" }, { "name": "order_by", "in": "query", "description": "Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.", "required": false, "type": "string" }, { "name": "start_position", "in": "query", "description": "Specifies the the starting location in the result set of the items that are returned.", "required": false, "type": "string" }, { "name": "to_date", "in": "query", "description": "Specifies the end of the date range to return.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/folderItemResponse" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "search", "x-ds-method": "search", "x-ds-service": "Folders", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/settings": { "get": { "tags": [ "Accounts" ], "summary": "Gets account settings information.", "description": "Retrieves the account settings information for the specified account.", "operationId": "Settings_GetSettings", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/accountSettingsInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listSettings", "x-ds-method": "listSettings", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "put": { "tags": [ "Accounts" ], "summary": "Updates the account settings for an account.", "description": "Updates the account settings for the specified account.", "operationId": "Settings_PutSettings", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "accountSettingsInformation", "in": "body", "required": false, "schema": { "$ref": "#/definitions/accountSettingsInformation" }, "description": "" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateSettings", "x-ds-method": "updateSettings", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/settings/enote_configuration": { "get": { "tags": [ "ENoteConfigurations" ], "summary": "Returns the configuration information for the eNote eOriginal integration.", "operationId": "ENoteConfiguration_GetENoteConfiguration", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/ENoteConfigurations" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getENoteConfiguration", "x-ds-api-status": "beta", "x-ds-method": "get", "x-ds-service": "Accounts", "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ "ENoteConfigurations" ], "summary": "Updates configuration information for the eNote eOriginal integration.", "operationId": "ENoteConfiguration_PutENoteConfiguration", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "ENoteConfigurations", "in": "body", "required": false, "schema": { "$ref": "#/definitions/ENoteConfigurations" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/ENoteConfigurations" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateENoteConfiguration", "x-ds-api-status": "beta", "x-ds-method": "update", "x-ds-service": "Accounts", "description": "", "x-ds-in-sdk": true }, "delete": { "tags": [ "ENoteConfigurations" ], "summary": "Deletes configuration information for the eNote eOriginal integration.", "operationId": "ENoteConfiguration_DeleteENoteConfiguration", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteENoteConfiguration", "x-ds-api-status": "beta", "x-ds-method": "delete", "x-ds-service": "Accounts", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration": { "get": { "tags": [ "EnvelopePurgeConfiguration" ], "summary": "", "operationId": "EnvelopePurgeConfiguration_GetEnvelopePurgeConfiguration", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopePurgeConfiguration" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getEnvelopePurgeConfiguration", "x-ds-api-status": "beta", "x-ds-method": "getEnvelopePurgeConfiguration", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ "EnvelopePurgeConfiguration" ], "summary": "", "operationId": "EnvelopePurgeConfiguration_PutEnvelopePurgeConfiguration", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "envelopePurgeConfiguration", "in": "body", "required": false, "schema": { "$ref": "#/definitions/envelopePurgeConfiguration" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopePurgeConfiguration" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateEnvelopePurgeConfiguration", "x-ds-api-status": "beta", "x-ds-method": "updateEnvelopePurgeConfiguration", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/settings/notification_defaults": { "get": { "tags": [ "NotificationDefaults" ], "summary": "", "operationId": "NotificationDefaults_GetNotificationDefaults", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/NotificationDefaults" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getNotificationDefaults", "x-ds-method": "getNotificationDefaults", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ "NotificationDefaults" ], "summary": "", "operationId": "NotificationDefaults_PutNotificationDefaults", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "NotificationDefaults", "in": "body", "required": false, "schema": { "$ref": "#/definitions/NotificationDefaults" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/NotificationDefaults" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateNotificationDefaults", "x-ds-method": "updateNotificationDefaults", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/settings/password_rules": { "get": { "tags": [ "AccountPasswordRules" ], "summary": "Get the password rules", "operationId": "AccountPasswordRules_GetAccountPasswordRules", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountPasswordRules" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getAccountPasswordRules", "x-ds-method": "get", "x-ds-service": "Accounts", "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ "AccountPasswordRules" ], "summary": "Update the password rules", "operationId": "AccountPasswordRules_PutAccountPasswordRules", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "AccountPasswordRules", "in": "body", "required": false, "schema": { "$ref": "#/definitions/AccountPasswordRules" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountPasswordRules" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateAccountPasswordRules", "x-ds-method": "update", "x-ds-service": "Accounts", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/settings/tabs": { "get": { "tags": [ "AccountTabSettings" ], "summary": "Returns tab settings list for specified account", "operationId": "TabSettings_GetTabSettings", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountTabSettings" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getAccountTabSettings", "x-ds-method": "get", "x-ds-service": "Accounts", "description": "", "x-ds-in-sdk": true }, "put": { "tags": [ "AccountTabSettings" ], "summary": "Modifies tab settings for specified account", "operationId": "TabSettings_PutSettings", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "AccountTabSettings", "in": "body", "required": false, "schema": { "$ref": "#/definitions/AccountTabSettings" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountTabSettings" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateAccountTabSettings", "x-ds-method": "update", "x-ds-service": "Accounts", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/shared_access": { "get": { "tags": [ "Accounts" ], "summary": "Reserved: Gets the shared item status for one or more users.", "description": "Retrieves shared item status for one or more users and types of items.\n\nUsers with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the `shared` parameter to `shared_from`.", "operationId": "SharedAccess_GetSharedAccess", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "count", "in": "query", "description": "Specifies the maximum number of results included in the response. If no value is specified, this defaults to 1000.", "required": false, "type": "string" }, { "name": "envelopes_not_shared_user_status", "in": "query", "required": false, "type": "string", "description": "This query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the results to only users that match the specified status:\n- `ActivationRequired`: Membership Activation required\n- `ActivationSent`: Membership activation sent to user\n- `Active`: User Membership is active\n- `Closed`: User Membership is closed\n- `Disabled`: User Membership is disabled" }, { "name": "folder_ids", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `folders`, at least one folder ID is required." }, { "name": "item_type", "in": "query", "description": "Specifies the type of shared item being requested. The possible values are:\n\n- `envelopes`: Get information about envelope sharing between users.\n- `templates`: Get information about template sharing among users and groups.\n- `folders`: Get information about folder sharing among users and groups.\n", "required": false, "type": "string" }, { "name": "search_text", "in": "query", "description": "Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.", "required": false, "type": "string" }, { "name": "shared", "in": "query", "description": "A comma-separated list of sharing filters that specifies which users appear in the response. \n\n- `not_shared`: The response lists users who do not share items of `item_type` with the current user.\n\n- `shared_to`: The response lists users in `user_list` who are sharing items to current user.\n\n- `shared_from`: The response lists users in `user_list` who are sharing items from the current user.\n\n- `shared_to_and_from`: The response lists users in `user_list` who are sharing items to and from the current user.\n\nIf the current user does not have administrative privileges, only the `shared_to` option is valid.", "required": false, "type": "string" }, { "name": "start_position", "in": "query", "description": "If the number of responses is greater than `count`, this specifies the number of responses to skip. Typically this value is a multiple of `count`. The default is 0.", "required": false, "type": "string" }, { "name": "user_ids", "in": "query", "description": "A comma-separated list of user IDs for whom the shared item information is being requested.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/accountSharedAccess" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listSharedAccess", "x-ds-method": "listSharedAccess", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "put": { "tags": [ "Accounts" ], "summary": "Reserved: Sets the shared access information for users.", "description": "This sets the shared access status for one or more users or templates.\n\nWhen setting user shared access, only users with account administration privileges can set shared access status for envelopes.\n\nWhen setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates.\n\nChanges to the shared items status are not additive. The change always replaces the current status.\n\nTo change template shared access, add the query parameter `item_type` = `templates` to the request. When this is set, the user and envelopes properties are not required.\n\n", "operationId": "SharedAccess_PutSharedAccess", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "item_type", "in": "query", "required": false, "type": "string", "description": "Specifies the type of shared item being set:\n- `envelopes`: Set envelope sharing between users.\n- `templates`: Set information about template sharing among users and groups.\n- `folders`: Get information about folder sharing among users and groups.\n" }, { "name": "preserve_existing_shared_access", "in": "query", "required": false, "type": "string", "description": "When **true**, preserve the existing shared access settings." }, { "name": "user_ids", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of IDs for users whose shared item access is being set." }, { "name": "accountSharedAccess", "in": "body", "required": false, "schema": { "$ref": "#/definitions/accountSharedAccess" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/accountSharedAccess" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateSharedAccess", "x-ds-method": "updateSharedAccess", "x-ds-service": "Accounts", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/signatureProviders": { "get": { "tags": [ "AccountSignatureProviders" ], "summary": "Returns Account available signature providers for specified account.", "operationId": "AccountSignatureProviders_GetSignatureProviders", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/AccountSignatureProviders" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listSignatureProviders", "x-ds-method": "list", "x-ds-service": "Accounts", "description": "", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/signing_groups": { "get": { "tags": [ "SigningGroups" ], "summary": "Gets a list of the Signing Groups in an account.", "description": "Retrieves a list of all signing groups in the specified account.", "operationId": "SigningGroups_GetSigningGroups", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "group_type", "in": "query", "required": false, "type": "string", "description": "" }, { "name": "include_users", "in": "query", "description": "When set to **true**, the response includes the signing group members. ", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/signingGroupInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "list", "x-ds-method": "list", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "put": { "tags": [ "SigningGroups" ], "summary": "Updates signing group names.", "description": "Updates the name of one or more existing signing groups. ", "operationId": "SigningGroups_PutSigningGroups", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "signingGroupInformation", "in": "body", "required": false, "schema": { "$ref": "#/definitions/signingGroupInformation" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/signingGroupInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateList", "x-ds-method": "updateList", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "post": { "tags": [ "SigningGroups" ], "summary": "Creates a signing group. ", "description": "Creates one or more signing groups. \n\nMultiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. \n\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\n \nSigning groups can be used by any account user.", "operationId": "SigningGroups_PostSigningGroups", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "signingGroupInformation", "in": "body", "required": false, "schema": { "$ref": "#/definitions/signingGroupInformation" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/signingGroupInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "createList", "x-ds-method": "create", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "delete": { "tags": [ "SigningGroups" ], "summary": "Deletes one or more signing groups.", "description": "Deletes one or more signing groups in the specified account.", "operationId": "SigningGroups_DeleteSigningGroups", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "signingGroupInformation", "in": "body", "required": false, "schema": { "$ref": "#/definitions/signingGroupInformation" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/signingGroupInformation" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteList", "x-ds-method": "delete", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}": { "get": { "tags": [ "SigningGroups" ], "summary": "Gets information about a signing group. ", "description": "Retrieves information, including group member information, for the specified signing group. ", "operationId": "SigningGroups_GetSigningGroup", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "signingGroupId", "in": "path", "required": true, "type": "string", "description": "The id of the signing group of which the recipient is a member, if applicable." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/SigningGroups" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "get", "x-ds-method": "get", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "put": { "tags": [ "SigningGroups" ], "summary": "Updates a signing group. ", "description": "Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members. ", "operationId": "SigningGroups_PutSigningGroup", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "signingGroupId", "in": "path", "required": true, "type": "string", "description": "The id of the signing group of which the recipient is a member, if applicable." }, { "name": "SigningGroups", "in": "body", "required": false, "schema": { "$ref": "#/definitions/SigningGroups" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/SigningGroups" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "update", "x-ds-method": "update", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users": { "get": { "tags": [ "SigningGroupUsers" ], "summary": "Gets a list of members in a Signing Group.", "description": "Retrieves the list of members in the specified Signing Group.", "operationId": "SigningGroups_GetSigningGroupUsers", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "signingGroupId", "in": "path", "required": true, "type": "string", "description": "The id of the signing group of which the recipient is a member, if applicable." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/SigningGroupUsers" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "listUsers", "x-ds-method": "list", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "put": { "tags": [ "SigningGroupUsers" ], "summary": "Adds members to a signing group. ", "description": "Adds one or more new members to a signing group. A signing group can have a maximum of 50 members. ", "operationId": "SigningGroups_PutSigningGroupUsers", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "signingGroupId", "in": "path", "required": true, "type": "string", "description": "The id of the signing group of which the recipient is a member, if applicable." }, { "name": "SigningGroupUsers", "in": "body", "required": false, "schema": { "$ref": "#/definitions/SigningGroupUsers" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/SigningGroupUsers" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "updateUsers", "x-ds-method": "update", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "delete": { "tags": [ "SigningGroupUsers" ], "summary": "Deletes one or more members from a signing group.", "description": "Deletes one or more members from the specified signing group. ", "operationId": "SigningGroups_DeleteSigningGroupUsers", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "signingGroupId", "in": "path", "required": true, "type": "string", "description": "The id of the signing group of which the recipient is a member, if applicable." }, { "name": "SigningGroupUsers", "in": "body", "required": false, "schema": { "$ref": "#/definitions/SigningGroupUsers" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/SigningGroupUsers" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "deleteUsers", "x-ds-method": "delete", "x-ds-service": "SigningGroups", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/supported_languages": { "get": { "tags": [ "Accounts" ], "summary": "List supported languages for the recipient language setting", "operationId": "SupportedLanguages_GetSupportedLanguages", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/supportedLanguages" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "getSupportedLanguages", "x-ds-method": "listSupportedLanguages", "x-ds-service": "Accounts", "description": "List supported languages for the recipient language setting", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/tab_definitions": { "get": { "tags": [ "CustomTabs" ], "summary": "Gets a list of all account tabs.", "description": "Retrieves a list of all tabs associated with the account.", "operationId": "Tabs_GetTabDefinitions", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "custom_tab_only", "in": "query", "description": "When set to **true**, only custom tabs are returned in the response. ", "required": false, "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/tabMetadataList" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "list", "x-ds-method": "list", "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "post": { "tags": [ "CustomTabs" ], "summary": "Creates a custom tab.", "description": "Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.\n\nCustom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.", "operationId": "Tabs_PostTabDefinitions", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "CustomTabs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/CustomTabs" }, "description": "" } ], "responses": { "201": { "description": "Successful response.", "schema": { "$ref": "#/definitions/CustomTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "create", "x-ds-method": "create", "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/tab_definitions/{customTabId}": { "get": { "tags": [ "CustomTabs" ], "summary": "Gets custom tab information.", "description": "Retrieves information about the requested custom tab on the specified account.", "operationId": "Tab_GetCustomTab", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "customTabId", "in": "path", "required": true, "type": "string", "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/CustomTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "get", "x-ds-method": "get", "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "put": { "tags": [ "CustomTabs" ], "summary": "Updates custom tab information.\n\n", "description": "Updates the information in a custom tab for the specified account.", "operationId": "Tab_PutCustomTab", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "customTabId", "in": "path", "required": true, "type": "string", "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." }, { "name": "CustomTabs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/CustomTabs" }, "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/CustomTabs" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "update", "x-ds-method": "update", "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "delete": { "tags": [ "CustomTabs" ], "summary": "Deletes custom tab information.", "description": "Deletes the custom from the specified account.", "operationId": "Tab_DeleteCustomTab", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "customTabId", "in": "path", "required": true, "type": "string", "description": "The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties." } ], "responses": { "200": { "description": "Successful response." }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "delete", "x-ds-method": "delete", "x-ds-service": "CustomTabs", "x-ds-in-sdk": true }, "parameters": [] }, "/v2.1/accounts/{accountId}/templates": { "get": { "tags": [ "Templates" ], "summary": "Gets the definition of a template.", "description": "Retrieves the list of templates for the specified account. The request can be limited to a specific folder.", "operationId": "Templates_GetTemplates", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" }, { "name": "count", "in": "query", "description": "Number of records to return in the cache.", "required": false, "type": "string" }, { "name": "created_from_date", "in": "query", "required": false, "type": "string", "description": "List templates created on or after this date." }, { "name": "created_to_date", "in": "query", "required": false, "type": "string", "description": "List templates modified before this date." }, { "name": "folder_ids", "in": "query", "description": "A comma separated list of folder ID GUIDs.", "required": false, "type": "string" }, { "name": "folder_types", "in": "query", "required": false, "type": "string", "description": "The type of folder to return templates for. Possible values are:\n\n- `templates`: Templates in the **My Templates** folder.\n Templates in the **Shared Templates** and **All Template** folders (if the request id from and Admin) are excluded.\n- `templates_root`: Templates in the root level of the **My Templates** folder, but not in an actual folder. Note that the **My Templates** folder is not a real folder.\n- `recylebin`: Templates that have been deleted.\n" }, { "name": "from_date", "in": "query", "description": "Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.", "required": false, "type": "string" }, { "name": "include", "in": "query", "description": "A comma-separated list\nof additional template attributes\nto include in the response.\nValid values are:\n\n- `advanced_templates`\n- `custom_fields`\n- `documents`\n- `folders`\n- `notifications`\n- `pathExtended`\n- `powerforms`\n- `recipients`\n- `shared_template_folders`\n\n`pathExtended`: Includes SalesForce configuration data for merge fields\nthat can be used to optimize upload template\nby eliminating the need to connect to SalesForce.", "required": false, "type": "string" }, { "name": "is_download", "in": "query", "required": false, "type": "string", "description": "When **true**, download the templates listed in `template_ids` as a ZIP file.\n\nThe `Content-Disposition` header is set in the response. The value of the header provides the filename of the file.\n\nDefault is **false**." }, { "name": "modified_from_date", "in": "query", "required": false, "type": "string", "description": "List templates modified on or after this date." }, { "name": "modified_to_date", "in": "query", "required": false, "type": "string", "description": "List templates modified before this date." }, { "name": "order", "in": "query", "description": "Specifies the sort order of the search results.\nValid values are:\n\n- `asc`: Ascending (A to Z)\n- `desc`: Descending (Z to A)", "required": false, "type": "string" }, { "name": "order_by", "in": "query", "description": "Specifies how the search results are listed.\nValid values are:\n\n- `name`: template name\n- `modified`: date/time template was last modified\n- `used`: date/time the template was last used.", "required": false, "type": "string" }, { "name": "search_fields", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of additional template properties to search.\n\n\n- `sender`: Include sender name and email in the search.\n- `recipients`: Include recipient names and emails in the search.\n- `envelope`: Not used in template searches.\n" }, { "name": "search_text", "in": "query", "description": "The search text used to search the names of templates.", "required": false, "type": "string" }, { "name": "shared_by_me", "in": "query", "description": "If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.", "required": false, "type": "string" }, { "name": "start_position", "in": "query", "description": "The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).", "required": false, "type": "string" }, { "name": "template_ids", "in": "query", "required": false, "type": "string", "description": "A comma-separated list of template IDs to download. This value is valid only when `is_download` is **true**." }, { "name": "to_date", "in": "query", "description": "End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.", "required": false, "type": "string" }, { "name": "used_from_date", "in": "query", "description": "Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.", "required": false, "type": "string" }, { "name": "used_to_date", "in": "query", "description": "End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.", "required": false, "type": "string" }, { "name": "user_filter", "in": "query", "description": "Filters the templates in the response. Valid values are: \n\n- `owned_by_me`: Results include only templates owned by the user.\n- `shared_with_me`: Results include only templates owned by the user. \n- `all`: Results include all templates owned or shared with the user.", "required": false, "type": "string" }, { "name": "user_id", "in": "query", "required": false, "type": "string", "description": "The user ID." } ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/envelopeTemplateResults" } }, "400": { "description": "Error encountered.", "schema": { "$ref": "#/definitions/errorDetails" } } }, "deprecated": false, "x-ds-methodname": "ListTemplates", "x-ds-method": "list", "x-ds-service": "Templates", "x-ds-in-sdk": true }, "post": { "tags": [ "Templates" ], "summary": "Creates a template.", "description": "Creates a template definition using a multipart request.\n\n### Template Email Subject Merge Fields\n\nCall this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template.\n\nThe merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line.\n\nBoth the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient.\n\n\n###### If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject.\n\nTo add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template:\n\n`[[Information Security notice: This method provides full access to the sender's user account.\nWhen you use this view, the sender has full access to the user account. If the sender user account has administrative privileges, then this method also provides administrator access.
\n\nIf your use case needs to enable a sender to update a draft envelope before it is sent, then either:
\n\n\n
\n- Configure each sender to have their own individual user account to use this API method.
\n- Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients and other envelope settings as needed.
\n
\nThe `signHere` tab appears 21 points *lower*\nthan the value you provide here.\nTo align the tab as expected,\nsubtract 21 from the expected y-value.\n
\n\nSee [Sign Here Tab Alignment](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/#sign-here-tab-alignment)\n
\n