DocuSign: Esignature schemas (part 32)
46 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Returns the tabs on a document — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Document tabs are tabs that are associated with a document rather than with a recipient. |
approveTabs | array | Optional | A list of [Approve tabs][approve]. An Approve tab enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. The value of an approve tab can't be set. [approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
approveTabs[] | Model | Each item | Expand Returns tabs on a template — response body — approve Tabs item |
checkboxTabs | array | Optional | A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
checkboxTabs[] | Model | Each item | Expand Returns tabs on a template — response body — checkbox Tabs item |
commentThreadTabs | array | Optional | An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. |
commentThreadTabs[] | Model | Each item | Expand Returns tabs on a template — response body — comment Thread Tabs item |
commissionCountyTabs | array | Optional | A list of [Commission County tabs][cc]. A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionCountyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission County Tabs item |
commissionExpirationTabs | array | Optional | A list of [Commission Expiration tabs][tabref]. A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionExpirationTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Expiration Tabs item |
commissionNumberTabs | array | Optional | A list of [Commission Number tabs][tabref]. A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Number Tabs item |
commissionStateTabs | array | Optional | A list of [Commission State tabs][cc]. A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionStateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission State Tabs item |
companyTabs | array | Optional | A list of [Company tabs][company]. A Company tab displays a field for the name of the recipient's company. This value can't be set. [company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company |
companyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — company Tabs item |
dateSignedTabs | array | Optional | A list of [Date Signed tabs][dateSigned]. A Date Signed tab displays the date that the recipient signed the document. This value can't be set. [dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateSignedTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Signed Tabs item |
dateTabs | array | Optional | A list of [Date tabs][date]. A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. [date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Tabs item |
declineTabs | array | Optional | A list of [Decline tabs][decline]. A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. [decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
declineTabs[] | Model | Each item | Expand Returns tabs on a template — response body — decline Tabs item |
drawTabs | array | Optional | A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. |
drawTabs[] | Model | Each item | Expand Returns tabs on a template — response body — draw Tabs item |
emailAddressTabs | array | Optional | A list of [Email Address tabs][emailAddress]. An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. [emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailAddressTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Address Tabs item |
emailTabs | array | Optional | A list of [Email tabs][email]. An Email tab enables the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. [email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Tabs item |
envelopeIdTabs | array | Optional | A list of [Envelope ID tabs][envelopeId]. An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. [envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid |
envelopeIdTabs[] | Model | Each item | Expand Returns tabs on a template — response body — envelope Id Tabs item |
firstNameTabs | array | Optional | A list of [First Name tabs][firstName]. A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. [firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname |
firstNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — first Name Tabs item |
formulaTabs | array | Optional | A list of [Formula tabs][formulaTab]. The value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields]. If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide]. [calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html [paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html [formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
formulaTabs[] | Model | Each item | Expand Returns tabs on a template — response body — formula Tabs item |
fullNameTabs | array | Optional | A list of [Full Name tabs][fullName]. A Full Name tab displays the recipient's full name. This value can't be set. [fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
fullNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — full Name Tabs item |
initialHereTabs | array | Optional | A list of [Initial Here tabs][initialHere]. This type of tab enables the recipient to initial the document. May be optional. This value can't be set. [initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
initialHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — initial Here Tabs item |
lastNameTabs | array | Optional | A list of [Last Name tabs][lastName]. A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. [lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
lastNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — last Name Tabs item |
listTabs | array | Optional | An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
listTabs[] | Model | Each item | Expand Returns tabs on a template — response body — list Tabs item |
notarizeTabs | array | Optional | A list of [Notarize tabs][notarize]. A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. [notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
notarizeTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notarize Tabs item |
notarySealTabs | array | Optional | A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. [notary]: /docs/notary-api/ |
notarySealTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notary Seal Tabs item |
noteTabs | array | Optional | A list of [Note tabs][note]. A Note tab displays additional information to the recipient in the form of a note. This value can be set. [note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
noteTabs[] | Model | Each item | Expand Returns tabs on a template — response body — note Tabs item |
numberTabs | array | Optional | A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). [number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
numberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — number Tabs item |
numericalTabs | array | Optional | A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). |
numericalTabs[] | Model | Each item | Expand Returns tabs on a template — response body — numerical Tabs item |
phoneNumberTabs | array | Optional | A list of [Phone Number tabs][cc]. A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
phoneNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — phone Number Tabs item |
polyLineOverlayTabs | array | Optional | This type of tab enables the recipient to strike through document text. This value can't be set. |
polyLineOverlayTabs[] | Model | Each item | Expand Returns tabs on a template — response body — poly Line Overlay Tabs item |
prefillTabs | Model | Optional | Expand Returns tabs on a template — response body — prefill Tabs Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
radioGroupTabs | array | Optional | A list of [Radio Group tabs][radioGroup]. A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. [radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
radioGroupTabs[] | Model | Each item | Expand Returns tabs on a template — response body — radio Group Tabs item |
signHereTabs | array | Optional | A list of [Sign Here tabs][signHere]. This type of tab enables the recipient to sign a document. May be optional. This value can't be set. [signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — sign Here Tabs item |
signerAttachmentTabs | array | Optional | A list of [Signer Attachment tabs][signerAttachment]. This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. [signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signerAttachmentTabs[] | Model | Each item | Expand Returns tabs on a template — response body — signer Attachment Tabs item |
smartSectionTabs | array | Optional | A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. |
smartSectionTabs[] | Model | Each item | Expand Returns tabs on a template — response body — smart Section Tabs item |
ssnTabs | array | Optional | A list of [SSN tabs][ssn]. An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. [ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
ssnTabs[] | Model | Each item | Expand Returns tabs on a template — response body — ssn Tabs item |
tabGroups | array | Optional | An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. |
tabGroups[] | Model | Each item | Expand Returns tabs on a template — response body — tab Groups item |
textTabs | array | Optional | A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
textTabs[] | Model | Each item | Expand Returns tabs on a template — response body — text Tabs item |
titleTabs | array | Optional | A list of [Title tabs][title]. A Title tab displays the recipient's title. This value can't be set. [title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
titleTabs[] | Model | Each item | Expand Returns tabs on a template — response body — title Tabs item |
viewTabs | array | Optional | A list of [View tabs][view]. A View tab is used with an Approve tab to handle supplemental documents. This value can be set. [view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
viewTabs[] | Model | Each item | Expand Returns tabs on a template — response body — view Tabs item |
zipTabs | array | Optional | A list of [Zip tabs][zip]. A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. [zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
zipTabs[] | Model | Each item | Expand Returns tabs on a template — response body — zip Tabs item |
Referenced models: Returns tabs on a template — response body — approve Tabs item, Returns tabs on a template — response body — checkbox Tabs item, Returns tabs on a template — response body — comment Thread Tabs item, Returns tabs on a template — response body — commission County Tabs item, Returns tabs on a template — response body — commission Expiration Tabs item, Returns tabs on a template — response body — commission Number Tabs item, Returns tabs on a template — response body — commission State Tabs item, Returns tabs on a template — response body — company Tabs item, Returns tabs on a template — response body — date Tabs item, Returns tabs on a template — response body — date Signed Tabs item, Returns tabs on a template — response body — decline Tabs item, Returns tabs on a template — response body — draw Tabs item, Returns tabs on a template — response body — email Tabs item, Returns tabs on a template — response body — email Address Tabs item, Returns tabs on a template — response body — envelope Id Tabs item, Returns tabs on a template — response body — first Name Tabs item, Returns tabs on a template — response body — formula Tabs item, Returns tabs on a template — response body — full Name Tabs item, Returns tabs on a template — response body — initial Here Tabs item, Returns tabs on a template — response body — last Name Tabs item, Returns tabs on a template — response body — list Tabs item, Returns tabs on a template — response body — notarize Tabs item, Returns tabs on a template — response body — notary Seal Tabs item, Returns tabs on a template — response body — note Tabs item, Returns tabs on a template — response body — number Tabs item, Returns tabs on a template — response body — numerical Tabs item, Returns tabs on a template — response body — phone Number Tabs item, Returns tabs on a template — response body — poly Line Overlay Tabs item, Returns tabs on a template — response body — prefill Tabs, Returns tabs on a template — response body — radio Group Tabs item, Returns tabs on a template — response body — sign Here Tabs item, Returns tabs on a template — response body — signer Attachment Tabs item, Returns tabs on a template — response body — smart Section Tabs item, Returns tabs on a template — response body — ssn Tabs item, Returns tabs on a template — response body — tab Groups item, Returns tabs on a template — response body — text Tabs item, Returns tabs on a template — response body — title Tabs item, Returns tabs on a template — response body — view Tabs item, Returns tabs on a template — response body — zip Tabs item
Returns the user authorization for a given authorization ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object describing a user authorization. |
agentUser | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User The user who can act on behalf of the principal user. |
authorizationId | string | Optional | The ID of the user authorization. |
created | string | Optional | The UTC DateTime when the workspace user authorization was created. |
createdBy | string | Optional | The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]` |
endDate | string | Optional | The UTC DateTime at which the authorization will expire. |
modified | string | Optional | The UTC DateTime when the workspace user authorization was last updated. |
modifiedBy | string | Optional | The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]` |
permission | string | Optional | The [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/shared-access/) to grant the agent. Valid values: * `Send` * `Manage` * `Sign` * `Edit` This property is required. |
principalUser | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User The user for whom the agent user acts. |
startDate | string | Optional | The UTC DateTime at which the authorization will start. |
taskSource | string | Optional | |
taskType | string | Optional |
Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body — agent User
Returns the workflow definition for a template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes the workflow for an envelope. |
currentWorkflowStepId | string | Optional | The `workflowStepId` of the current step. This is not an index into the `workflowSteps` array in this object. See the `workflowStep` object. |
resumeDate | string | Optional | The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the `resumeDate` property on `scheduledSending` and the `resumeDate` property on the current `workflowStep`. This property is read-only. |
scheduledSending | Model | Optional | Expand Updates the scheduled sending rules for an envelope's workflow — response body An object that describes the settings for scheduled sending. |
workflowStatus | string | Optional | The status of the workflow: - `paused` if the workflow is paused - `in_progress` if the workflow is in progress |
workflowSteps | array | Optional | An array of workflow steps. |
workflowSteps[] | Model | Each item | Expand Adds a new step to a template's workflow — response body |
Referenced models: Updates the scheduled sending rules for an envelope's workflow — response body, Adds a new step to a template's workflow — response body
Returns users from the configured Connect service — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allUsersSelected | string | Optional | |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
users | array | Optional | User management information. |
users[] | Model | Each item | Expand Gets a specific template associated with a specified account — response body — owner |
Referenced models: Gets a specific template associated with a specified account — response body — owner
Revokes the correction view URL to the Envelope UI — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request body for the [EnvelopeViews: createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/) method. |
beginOnTagger | string | Optional | |
returnUrl | string | Optional | (Required) The URL to which the user should be redirected after the view session has ended. Maximum Length: 470 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL Be sure to include `https://` in the URL or redirecting might fail on some browsers. When Docusign redirects to this URL, it will include an `event` query parameter that your app can use: * `send`: User corrected and sent the envelope. * `save`: User saved the envelope. * `cancel`: User canceled the transaction. * `error`: There was an error when performing the correct or send. * `sessionEnd`: The session ended before the user completed a different action. |
suppressNavigation | string | Optional | Specifies whether the window is displayed with or without dressing. |
viewUrl | string | Optional |
Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accessControlListBase64 | string | Optional | Reserved for Docusign. |
allowComments | string | Optional | When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document. |
allowMarkup | string | Optional | When **true,** the Document Markup feature is enabled. **Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level. |
allowReassign | string | Optional | When **true,** the recipient can redirect an envelope to a more appropriate recipient. |
allowViewHistory | string | Optional | When **true,** recipients can view the history of the envelope. |
anySigner | string | Optional | Deprecated. This feature has been replaced by signing groups. |
asynchronous | string | Optional | When **true,** the envelope is queued for processing and the value of the `status` property is set to `Processing`. Additionally, GET status calls return `Processing` until completed. **Note:** A `transactionId` is required for this call to work correctly. When the envelope is created, the status is `Processing` and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query by using the [transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the Connect notification. |
attachmentsUri | string | Optional | Contains a URL for retrieving the attachments that are associated with the envelope. |
authoritativeCopy | string | Optional | When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** |
authoritativeCopyDefault | string | Optional | The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope's `authoritativeCopy`. |
autoNavigation | string | Optional | When **true,** autonavigation is set for the recipient. |
brandId | string | Optional | The ID of the brand. |
brandLock | string | Optional | When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. |
burnDefaultTabData | string | Optional | |
certificateUri | string | Optional | The URI for retrieving certificate information. |
completedDateTime | string | Optional | Specifies the date and time this item was completed. |
copyRecipientData | string | Optional | |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customFields | Model | Optional | Expand Gets a list of custom fields — response body An optional array of strings that enables the sender to provide custom data about the envelope. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters. |
customFieldsUri | string | Optional | The URI for retrieving custom fields. |
declinedDateTime | string | Optional | The date and time the recipient declined the document. This property is read-only. |
deletedDateTime | string | Optional | Reserved for Docusign. |
deliveredDateTime | string | Optional | The date and time that the envelope was delivered to the recipient. This property is read-only. |
disableResponsiveDocument | string | Optional | When **true,** responsive documents are disabled for the envelope. |
documentBase64 | string | Optional | The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. |
documentsCombinedUri | string | Optional | The URI for retrieving all of the documents associated with the envelope as a single PDF file. |
documentsUri | string | Optional | The URI for retrieving all of the documents associated with the envelope as separate files. |
emailBlurb | string | Optional | This is the same as the email body. If specified it is included in email body for all envelope recipients. |
emailSettings | Model | Optional | Expand Adds email setting overrides to an envelope — response body A complex type that contains email settings. |
emailSubject | string | Optional | The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. |
enableWetSign | string | Optional | When **true,** the signer is allowed to print the document and sign it on paper. |
enforceSignerVisibility | string | Optional | When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting. **Note:** To use this functionality, [document visibility][docviz] must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support][support] or your account manager to find out whether document visibility is available for your production account plan. [docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/ [sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending [fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html [support]: https://support.docusign.com/en/contactSupport# |
envelopeAttachments | array | Optional | An array of attachment objects that provide information about the attachments that are associated with the envelope. |
envelopeAttachments[] | Model | Each item | Expand Updates an envelope attachment in a draft or in-process envelope — request body — body |
envelopeCustomMetadata | Model | Optional | Expand Gets the status of a single envelope — response body — envelope Custom Metadata |
envelopeDocuments | array | Optional | An array containing information about the documents that are included in the envelope. |
envelopeDocuments[] | Model | Each item | Expand Updates a template document — response body |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
envelopeIdStamping | string | Optional | When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed. |
envelopeLocation | string | Optional | Reserved for Docusign. |
envelopeMetadata | Model | Optional | Expand Gets the status of a single envelope — response body — envelope Metadata Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and Docusign eNotary service. |
envelopeUri | string | Optional | The URI for retrieving the envelope or envelopes. |
expireAfter | string | Optional | Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. |
expireDateTime | string | Optional | The date and time that the envelope is set to expire. This value is determined by the `InitialSentDateTime` of the envelope and the `expireAfter` property of the `notification` object. (Note that the `expireAfter` property of the envelope itself is not used.) |
expireEnabled | string | Optional | Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. |
externalEnvelopeId | string | Optional | May contain an external identifier for the envelope. |
folders | array | Optional | A list of folder objects. |
folders[] | Model | Each item | Expand Creates an envelope — request body — body folders item |
hasComments | string | Optional | When **true,** indicates that users have added comments to the envelope. |
hasFormDataChanged | string | Optional | When **true,** indicates that the data collected through form fields on a document has changed. |
hasWavFile | string | Optional | When **true,** indicates that a .wav file used for voice authentication is included in the envelope. |
holder | string | Optional | Reserved for Docusign. |
initialSentDateTime | string | Optional | The date and time the envelope was initially sent. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
isDynamicEnvelope | string | Optional | When **true,** indicates that the envelope is a dynamic envelope. |
isSignatureProviderEnvelope | string | Optional | When **true,** indicates that the envelope is a signature-provided envelope. |
isTicketRelatedEnvelope | string | Optional | |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
location | string | Optional | Reserved for Docusign. |
lockInformation | Model | Optional | Expand Locks an envelope — response body Provides lock information about an envelope that a user has locked. |
messageLock | string | Optional | When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. |
notification | Model | Optional | Expand Gets envelope notification information — response body |
notificationUri | string | Optional | The URI for retrieving notifications. |
powerForm | Model | Optional | Expand Creates a new Power Form — request body — body Information about any PowerForms that are included in the envelope. |
purgeCompletedDate | string | Optional | The date that a purge was completed. |
purgeRequestDate | string | Optional | The date that a purge was requested. |
purgeState | string | Optional | Shows the current purge state for the envelope. Valid values: - `unpurged`: There has been no successful request to purge documents. - `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. - `documents_dequeued`: The envelope documents have been taken out of the purge queue. - `documents_purged`: The envelope documents have been successfully purged. - `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. - `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted. - `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted. **Related topics** - [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/) - [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope) |
recipients | Model | Optional | Expand Deletes recipients from an envelope — request body — body An array of recipient objects that provides details about the recipients of the envelope. |
recipientsLock | string | Optional | When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope. |
recipientsUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the recipients. |
sender | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the sender of the envelope. |
sentDateTime | string | Optional | The UTC DateTime when the envelope was sent. This property is read-only. |
signerCanSignOnMobile | string | Optional | When **true,** recipients can sign on a mobile device. **Note:** Only Admin users can change this setting. |
signingLocation | string | Optional | Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. |
status | string | Optional | Indicates the envelope status. Valid values are: * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. * `created`: The envelope is created as a draft. It can be modified and sent later. * `declined`: The envelope has been declined by the recipients. * `delivered`: The envelope has been delivered to the recipients. * `sent`: The envelope will be sent to the recipients after the envelope is created. * `signed`: The envelope has been signed by the recipients. * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. |
statusChangedDateTime | string | Optional | The data and time that the status changed. |
templatesUri | string | Optional | The URI for retrieving the templates. |
transactionId | string | Optional | Used to identify an envelope. The ID is a sender-generated value and is valid in the Docusign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet c onnection was lost before the envelope status was returned. |
uSigState | string | Optional | |
useDisclosure | string | Optional | When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. |
voidedDateTime | string | Optional | The date and time the envelope or template was voided. |
voidedReason | string | Optional | The reason the envelope or template was voided. **Note:** The string is truncated to the first 200 characters. |
workflow | Model | Optional | Expand Returns the workflow definition for a template — response body |
Referenced models: Gets a list of custom fields — response body, Locks an envelope — response body, Updates an envelope attachment in a draft or in-process envelope — request body — body, Adds email setting overrides to an envelope — response body, Gets the status of a single envelope — response body — envelope Custom Metadata, Updates a template document — response body, Gets the status of a single envelope — response body — envelope Metadata, Gets envelope notification information — response body, Gets a specific template associated with a specified account — response body — owner, Returns the workflow definition for a template — response body, Deletes recipients from an envelope — request body — body, Creates an envelope — request body — body folders item, Creates a new Power Form — request body — body
Set one or more templates as account favorites — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
favoriteTemplates | array | Optional | The favorite templates acted upon by the call. |
favoriteTemplates[] | Model | Each item | Expand Set one or more templates as account favorites — response body — favorite Templates item |
templatesUpdatedCount | integer | Optional | The number of templates successfully updated by the call. This property is read-only. Format: int32 |
Referenced models: Locks a template — response body — error Details, Set one or more templates as account favorites — response body — favorite Templates item
Set one or more templates as account favorites — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
favoriteTemplates | array | Optional | The favorite templates acted upon by the call. |
favoriteTemplates[] | Model | Each item | Expand Set one or more templates as account favorites — response body — favorite Templates item |
templatesUpdatedCount | JSON | Optional | |
templatesUpdatedCount (anyOf 1) | integer | Alternative | The number of templates successfully updated by the call. This property is read-only. Format: int32 |
templatesUpdatedCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Locks a template — response body — error Details, Set one or more templates as account favorites — response body — favorite Templates item
Set one or more templates as account favorites — response body — favorite Templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
favoritedDate | string | Optional | Time at which the template was marked as favorite. |
templateId | string | Optional | The ID of the template. |
Referenced models: Locks a template — response body — error Details
Set up Connect O Auth for the specified account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object describing a Connect OAuth configuration. |
authorizationServerUrl | string | Optional | The token URL for your authorization server or OAuth service. This property is required. |
clientId | string | Optional | The client ID assigned to your app by your authorization server or OAuth service. This property is required. |
clientSecret | string | Optional | The secret value provided by your authorization server. This property is required. |
customParameters | object | Optional | Additional keys: see wildcard field |
customParameters.* | string | Additional keys | |
scope | string | Optional | The scopes that your app will request from the authorization server. This property is optional. **Note:** If you are using Azure, this value is the application ID URI of the secified resource affixed with the `.default`. For example: `api://{{clientId}}/.default` |
Submits a batch of historical envelopes for republish to a webhook — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request body for the `createHistoricalEnvelopePublishTransaction` endpoint. |
config | Model | Optional | Expand Creates a Connect configuration — response body An object describing the ad hoc Connect configuration data. This object is required. **Note:** Regardless of the `eventData.version` parameter on this object, envelope data will always be transmitted in JSON format. XML is not supported. |
envelopes | array | Optional | An array of envelope IDs as comma-separated strings. This property is required. For example: `["4280f274-xxxx-xxxx-xxxx-b218b7eeda08","9586h293-xxxx-xxxx-xxxx-m923b8opre71","2347w948-xxxx-xxxx-xxxx-t096b8krno89"]` |
envelopes[] | string | Each item |
Referenced models: Creates a Connect configuration — response body
Submits a batch of historical envelopes for republish to a webhook — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applyConnectSettings | string | Optional | |
envelopeCount | string | Optional | |
envelopeLevelErrorRollups | array | Optional | |
envelopeLevelErrorRollups[] | Model | Each item | Expand Submits a batch of historical envelopes for republish to a webhook — response body — envelope Level Error Rollups item |
envelopePublishTransactionId | string | Optional | The ID of the publish transaction. |
errorCount | string | Optional | |
fileLevelErrors | array | Optional | |
fileLevelErrors[] | string | Each item | |
noActionRequiredEnvelopeCount | string | Optional | |
processedEnvelopeCount | string | Optional | |
processingStatus | string | Optional | The status of the transaction. Valid values: * `unprocessed` * `processing` * `complete` * `fatal_error` |
resultsUri | string | Optional | |
submissionDate | string | Optional | |
submittedByUserInfo | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner |
submittedForPublishingEnvelopeCount | string | Optional |
Referenced models: Submits a batch of historical envelopes for republish to a webhook — response body — envelope Level Error Rollups item, Gets a specific template associated with a specified account — response body — owner
Submits a batch of historical envelopes for republish to a webhook — response body — envelope Level Error Rollups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
count | string | Optional | The maximum number of results to return. |
errorType | string | Optional |
Updates a branding resource file — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences. |
createdByUserInfo | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner The user ID of the user who created the brand resource. |
createdDate | string | Optional | The date and time that the brand resource was created. |
dataNotSavedNotInMaster | array | Optional | Deprecated. |
dataNotSavedNotInMaster[] | string | Each item | |
modifiedByUserInfo | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who last modified the brand resource. |
modifiedDate | string | Optional | The date on which this user record was last modified. |
modifiedTemplates | array | Optional | This property is returned in the response to the [AccountBrands::listResources][listResources] request. It contains a list of any email templates that have been modified to differ from the master resource files. [listResources]: /docs/esign-rest-api/reference/accounts/accountbrands/listresources/ |
modifiedTemplates[] | string | Each item | |
resourcesContentType | string | Optional | The type of brand resource file. A brand uses a different resource file to control each of the following experiences: - Sending (`sending`) - Signing (`signing`) - Email messages (`email`) - Captive (embedded) signing (`signing_captive`) You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. |
resourcesContentUri | string | Optional | The URI for the brand resource file. |
Referenced models: Gets a specific template associated with a specified account — response body — owner
Updates a signing group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. |
created | string | Optional | The UTC DateTime when the signing group was created. This property is read-only. |
createdBy | string | Optional | The name of the user who created the signing group. This property is read-only. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
groupEmail | string | Optional | The email address for the signing group. You can use a group email address to email all of the group members at the same time. |
groupName | string | Optional | The name of the group. |
groupType | string | Optional | The type of the group. The only valid value for this request is `sharedSigningGroup`. |
modified | string | Optional | The UTC DateTime when the signing group was last modified. This property is read-only. |
modifiedBy | string | Optional | The user ID (GUID) of the user who last modified this user record. This property is read-only. |
signingGroupId | string | Optional | The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). |
users | array | Optional | User management information. |
users[] | Model | Each item | Expand Updates a signing group — response body — users item |
Referenced models: Locks a template — response body — error Details, Updates a signing group — response body — users item
Updates a signing group — response body — users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
userName | string | Optional | The name of the group member. Maximum Length: 100 characters. |
Referenced models: Locks a template — response body — error Details
Updates a template document — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about the envelope document. |
addedRecipientIds | array | Optional | If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only. |
addedRecipientIds[] | string | Each item | |
agreementType | string | Optional | |
agreementTypeSource | string | Optional | |
attachmentTabId | string | Optional | If this document is an attachment to another document in the envelope, this is the ID of the attachment tab it is associated with on the other document. |
authoritativeCopy | string | Optional | When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** |
authoritativeCopyMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents. |
availableDocumentTypes | array | Optional | |
availableDocumentTypes[] | Model | Each item | Expand Updates a template document — response body — available Document Types item |
containsPdfFormFields | string | Optional | When **true,** the document has editable form fields that are made available through a PDF format. |
display | string | Optional | This string sets the display and behavior properties of the document during signing. Valid values: * `modal`<br> The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. * `inline`<br> The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents. |
displayMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents. |
docGenDocumentStatus | string | Optional | |
docGenErrors | array | Optional | |
docGenErrors[] | Model | Each item | Expand Updates a template document — response body — doc Gen Errors item |
docGenFormFields | array | Optional | |
docGenFormFields[] | Model | Each item | Expand Updates a template document — response body — doc Gen Form Fields item |
documentBase64 | string | Optional | The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. |
documentFields | array | Optional | An object containing information about the custom fields on the document. |
documentFields[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
documentId | string | Optional | The ID of the document that the tab is placed on. This value must refer to the ID of an existing document. |
documentIdGuid | string | Optional | The GUID of the document. |
documentTemplateId | string | Optional | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
hasDigitalSignature | string | Optional | |
includeInDownload | string | Optional | When **true,** the document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/). The default value is **true.** |
includeInDownloadMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents. |
isAceGenDocument | string | Optional | |
isDocGenDocument | string | Optional | |
isEdited | string | Optional | |
isExternallyAvailable | string | Optional | |
isFlattened | string | Optional | |
name | string | Optional | The document's file name. Example: `Q1-Report.docx` |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents. |
order | string | Optional | The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order. |
pages | array | Optional | An array of page objects that contain information about the pages in the document. |
pages[] | Model | Each item | Expand Creates a workspace file — response body — thumbnail |
signerMustAcknowledge | string | Optional | Sets how the signer interacts with the supplemental document. Valid values: * `no_interaction`<br> No recipient action is required. * `view`<br> The recipient is required to view the document. * `accept`<br> The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. * `view_accept`<br> The recipient is required to view and accept the document. |
signerMustAcknowledgeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents. |
sizeBytes | string | Optional | |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
type | string | Optional | The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` |
uri | string | Optional | The URI for retrieving the document. |
Referenced models: Updates a template document — response body — doc Gen Form Fields item, Updates a template document — response body — doc Gen Errors item, Locks a template — response body — error Details, Updates an existing brand — response body — colors item, Creates a workspace file — response body — thumbnail, Updates a template document — response body — name Metadata, Updates a template document — response body — available Document Types item
Updates a template document — response body — available Document Types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about the type of signature. |
isDefault | string | Optional | When **true,** the signature type is the default type. |
type | string | Optional | The type of signature. Valid values are: - `electronic`: Indicates an **electronic** signature that is used by common law countries such as the United States, United Kingdom, and Australia. This is the default signature type that Docusign uses. - `universal`: Indicates a **digital** signature that is accepted by both common law and civil law countries. To use digital signatures, you must use the [Docusign Signature Appliance](/docs/dsa-api/). For more information, see [Standards Based Signatures](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). |
Updates a template document — response body — doc Gen Errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes document generation errors. |
errorCode | string | Optional | A code associated with the error condition. |
message | string | Optional | The error message. |
tagIdentifier | string | Optional | The tag that caused the syntax error. See [Document Generation Syntax](https://support.docusign.com/s/document-item?bundleId=als1679428547895&topicId=ftc1679700030026.html) to learn more about document generation syntax rules. |
Updates a template document — response body — doc Gen Form Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The document fields available for document generation. This object is used in reponses (GET) and requests (PUT). When used with [DocumentGeneration: updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) (PUT), the `name` and `value` / `rowValues` properties are required and any other values are ignored. |
connectedObjectDetails | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item connected Object Details |
defaultValue | string | Optional | |
description | string | Optional | A description of the field. Displayed with the label. |
filter | string | Optional | An object used to present a filtered view of the items in a folder. |
format | Model | Optional | Expand Updates a template document — response body — doc Gen Form Fields item format |
fullyQualifiedPath | string | Optional | |
hidden | string | Optional | |
label | string | Optional | A label displayed near the field. |
name | string | Optional | The name of the sender field. Required for PUT requests. |
options | array | Optional | When `type` is `Select`, this array describes the available options. |
options[] | Model | Each item | Expand Updates a template document — response body — doc Gen Form Fields item options item |
order | string | Optional | The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order. |
predefinedValidation | string | Optional | Reserved for Docusign. |
readOnly | string | Optional | |
required | string | Optional | When **true,** the field is required. |
rowValues | array | Optional | For fields of type `TableRow`, this property represents the sender fields in the row. For GET requests, this array contains a single `docGenFormFieldRowValue` object. That object contains a list of sender fields that will appear in each row. For PUT requests, you must supply a `docGenFormFieldRowValue` object for each row in the table. This populates the data in the table. |
rowValues[] | Model | Each item | Expand Updates a template document — response body — doc Gen Form Fields item row Values item |
type | string | Optional | The kind of data the sender field holds. Valid values: - `TextBox` - `Date` - `Number` - `Select` - `TableRow` |
validation | Model | Optional | Expand Updates a template document — response body — doc Gen Form Fields item validation Describes how values are validated. |
value | string | Optional | The value of the sender field. For PUT requests, you must supply either this property (for all fields except `TableRow` types) or `rowValues` (for `TableRow` fields). |
Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Updates a template document — response body — doc Gen Form Fields item options item, Updates a template document — response body — doc Gen Form Fields item row Values item, Updates a template document — response body — doc Gen Form Fields item validation, Updates a template document — response body — doc Gen Form Fields item format
Updates a template document — response body — doc Gen Form Fields item format
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expression | string | Optional | |
locale | string | Optional | The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es` |
Updates a template document — response body — doc Gen Form Fields item options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies an individual option setting when type is `Select`. |
description | string | Optional | Description of the selectable option. |
label | string | Optional | The label for the selectable option. |
selected | string | Optional | When **true,** the option is selected. |
value | string | Optional | Specifies the value of the option. This is the value of the form field when this option is selected. |
Updates a template document — response body — doc Gen Form Fields item row Values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object representing a row of a dynamic table. |
docGenFormFieldList | array | Optional | The sender fields in each row of the table. For GET requests, the `label`, `type`, `required`, and `name` properties will be returned. For POST requests, supply the `name` and `value` for each child object. These correspond to the values in each column. |
docGenFormFieldList[] | Model | Each item | Expand Updates a template document — response body — doc Gen Form Fields item |
Referenced models: Updates a template document — response body — doc Gen Form Fields item
Updates a template document — response body — doc Gen Form Fields item validation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes how values are validated. |
errorMessage | string | Optional | The error message when validation fails. |
expression | string | Optional | The expression used to validate values. |
Updates a template document — response body — name Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata about a property. |
options | array | Optional | An array of option strings supported by this setting. |
options[] | string | Each item | |
rights | string | Optional | Indicates whether the property is editable. Valid values are: - `editable` - `read_only` |
Updates an account billing plan — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a billing plan. |
appStoreReceipt | Model | Optional | Expand Updates an account billing plan — request body — body app Store Receipt |
billingAddress | Model | Optional | Expand Get Account Billing Plan — response body — billing Address The billing address for the account. |
creditCardInformation | Model | Optional | Expand Get credit card information — response body A complex type that has information about the credit card used to pay for this account. |
directDebitProcessorInformation | Model | Optional | Expand Get Account Billing Plan — response body — direct Debit Processor Information Information about the bank that processes direct debits for the payment plan. |
downgradeReason | string | Optional | (Optional) The user's reason for downgrading their billing plan. |
enablePreAuth | string | Optional | |
enableSupport | string | Optional | When **true,** customer support is provided as part of the account plan. |
includedSeats | string | Optional | The number of seats (users) included in the plan. |
incrementalSeats | string | Optional | Reserved for Docusign. |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
paymentProcessor | string | Optional | |
paymentProcessorInformation | Model | Optional | Expand Get Account Billing Plan — response body — payment Processor Information Information about the entity that processes payments for the billing plan. |
planInformation | Model | Optional | Expand Updates an account billing plan — request body — body plan Information An object used to identify the features and attributes of the account being created. |
processPayment | string | Optional | |
referralInformation | Model | Optional | Expand Get Account Billing Plan — response body — referral Information A complex type that contains properties for entering referral and discount information. |
renewalStatus | string | Optional | The renewal status of the account. Possible values are: - `auto`: The account automatically renews. - `queued_for_close`: The account will be closed at the billingPeriodEndDate. - queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`. |
saleDiscountAmount | string | Optional | Reserved for Docusign. |
saleDiscountFixedAmount | string | Optional | Reserved for Docusign. |
saleDiscountPercent | string | Optional | Reserved for Docusign. |
saleDiscountPeriods | string | Optional | Reserved for Docusign. |
saleDiscountSeatPriceOverride | string | Optional | Reserved for Docusign. |
taxExemptId | string | Optional |
Referenced models: Get Account Billing Plan — response body — billing Address, Get credit card information — response body, Get Account Billing Plan — response body — direct Debit Processor Information, Get Account Billing Plan — response body — payment Processor Information, Get Account Billing Plan — response body — referral Information, Updates an account billing plan — request body — body app Store Receipt, Updates an account billing plan — request body — body plan Information
Updates an account billing plan — request body — body app Store Receipt
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an APP store receipt. |
downgradeProductId | string | Optional | |
isDowngradeCancellation | string | Optional | |
productId | string | Optional | The Product ID from the AppStore. |
receiptData | string | Optional | Reserved for Docusign. |
Updates an account billing plan — request body — body plan Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object used to identify the features and attributes of the account being created. |
addOns | array | Optional | Reserved for Docusign. |
addOns[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan add Ons item |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
freeTrialDaysOverride | string | Optional | Reserved for Docusign. |
planFeatureSets | array | Optional | Reserved for Docusign. |
planFeatureSets[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan plan Feature Sets item |
planId | string | Optional | Docusign's ID for the account plan. |
recipientDomains | array | Optional | |
recipientDomains[] | Model | Each item | Expand Retrieves the account information for the specified account — response body — recipient Domains item |
Referenced models: Get Account Billing Plan — response body — billing Plan add Ons item, Get Account Billing Plan — response body — billing Plan plan Feature Sets item, Retrieves the account information for the specified account — response body — recipient Domains item
Updates an account billing plan — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a billing plan update response object. |
accountPaymentMethod | string | Optional | The type of payment method used for the account. Valid values are: - `credit_card` - |
billingPlanPreview | Model | Optional | Expand Updates an account billing plan — response body — billing Plan Preview |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
includedSeats | string | Optional | The number of seats (users) included in the plan. |
paymentCycle | string | Optional | The payment cycle associated with the plan. Valid values: - `Monthly` - `Annually` |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
planId | string | Optional | Docusign's ID for the account plan. |
planName | string | Optional | The name of the billing plan used for the account. Examples: - `Personal - Annual` - `Unlimited Envelope Subscription - Annual Billing` |
Referenced models: Updates an account billing plan — response body — billing Plan Preview
Updates an account billing plan — response body — billing Plan Preview
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information used to provide a preview of a billing plan. |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
invoice | Model | Optional | Expand Retrieves a billing invoice — response body |
isProrated | string | Optional | When **true,** the billing plan is prorated. |
subtotalAmount | string | Optional | |
taxAmount | string | Optional | |
totalAmount | string | Optional |
Referenced models: Retrieves a billing invoice — response body
Updates an envelope attachment in a draft or in-process envelope — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an attachment. |
accessControl | string | Optional | Valid values are `sender` and `senderAndAllRecipients`. |
attachmentId | string | Optional | The unique identifier for the attachment. |
attachmentType | string | Optional | Specifies the type of the attachment for the recipient. |
data | string | Optional | A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. |
label | string | Optional | A label for the attachment. Potential values include: - `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms. - `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. |
name | string | Optional | The name of the attachment. |
remoteUrl | string | Optional | The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads. |
Updates an existing brand — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope. |
brandCompany | string | Optional | The name of the company associated with the brand. |
brandId | string | Optional | The ID used to identify a specific brand in API calls. |
brandLanguages | array | Optional | An array of two-letter codes for the languages that you want to use with the brand. The supported languages are: - Arabic (`ar`) - Armenian (`hy`) - Bahasa Indonesia (`id`) - Bahasa Malay (`ms`) - Bulgarian (`bg`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Czech (`cs`) - Danish (`da`) - Dutch (`nl`) - English UK (`en_GB`) - English US (`en`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canada (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brasil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukranian (`uk`) - Vietnamese (`vi`) |
brandLanguages[] | string | Each item | |
brandName | string | Optional | The name of the brand. |
colors | array | Optional | An array of name-value pairs specifying the colors that the brand uses for the following elements: - Button background - Button text - Header background - Header text |
colors[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
defaultBrandLanguage | string | Optional | The two-letter code for the language that you want to use as the brand default. The supported languages are: - Arabic (`ar`) - Armenian (`hy`) - Bahasa Indonesia (`id`) - Bahasa Malay (`ms`) - Bulgarian (`bg`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Czech (`cs`) - Danish (`da`) - Dutch (`nl`) - English UK (`en_GB`) - English US (`en`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canada (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brasil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukranian (`uk`) - Vietnamese (`vi`) |
emailContent | array | Optional | Deprecated. |
emailContent[] | Model | Each item | Expand Updates an existing brand — response body — email Content item |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
isOrganizationBrand | string | Optional | |
isOverridingCompanyName | boolean | Optional | When **true,** the `brandCompany` property is overriding the name of the company in the account settings. |
isSendingDefault | boolean | Optional | When **true,** the sending brand is the default brand for sending new envelopes. |
isSigningDefault | boolean | Optional | When **true,** the siging brand is the default brand for the signing experience. |
landingPages | array | Optional | An array of name/value pairs specifying the pages to which the user is redirected after the following events occur: - Signing Completed - Viewed Exit - Finish Later - Decline - Session Timeout - Authentication Failure If you do not specify landing pages, the Docusign default pages are used. |
landingPages[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
links | array | Optional | An array of `brandLink` objects that contain information about the links that the brand uses. |
links[] | Model | Each item | Expand Updates an existing brand — response body — links item |
logoIds | Model | Optional | Expand Updates an existing brand — response body — logo Ids |
logos | Model | Optional | Expand Updates an existing brand — response body — logos The URIs for retrieving the logos that are associated with the brand. |
organizationBrandLogo | string | Optional | |
resources | Model | Optional | Expand Updates an existing brand — response body — resources An object containing the URLs for the four Docusign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. **Note:** This object is returned only when the `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`. |
Referenced models: Updates an existing brand — response body — email Content item, Updates an existing brand — response body — links item, Updates an existing brand — response body — logo Ids, Updates an existing brand — response body — logos, Updates an existing brand — response body — resources, Locks a template — response body — error Details, Updates an existing brand — response body — colors item
Updates an existing brand — response body — colors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A name-value pair that describes an item and provides a value for the item. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
name | string | Optional | The name of the item. |
originalValue | string | Optional | The initial value of the item. |
value | string | Optional | The current value of the item. |
Referenced models: Locks a template — response body — error Details
Updates an existing brand — response body — email Content item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deprecated. |
content | string | Optional | Deprecated. |
emailContentType | string | Optional | Deprecated. |
emailToLink | string | Optional | Deprecated. |
linkText | string | Optional | Deprecated. |
Updates an existing brand — response body — links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a link that a brand uses. |
linkText | string | Optional | The text used for the link. |
linkType | string | Optional | The type of link. Valid values include: - `aboutDocusign` - `closeButton` |
showLink | string | Optional | When **true,** the link displays to the recipient. |
urlOrMailTo | string | Optional | The URL or mailto address of the link. |
Updates an existing brand — response body — logo Ids
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
emailLogoId | string | Optional | |
primaryLogoId | string | Optional | |
secondaryLogoId | string | Optional |
Updates an existing brand — response body — logos
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The URIs for retrieving the logos that are associated with the brand. These are read-only properties that provide a URI to logos in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). |
email | string | Optional | The URI for the brand's secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). |
primary | string | Optional | The URI for the brand's secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). |
secondary | string | Optional | The URI for the brand's secondary logo. This is a read-only property that provides a URI to the logo in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). |
Updates an existing brand — response body — resources
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Brands use resource files to style the following experiences: - Sending - Signing - Captive (embedded) signing You can modify these resource files to customize these experiences. |
email | string | Optional | The URI for the email resource file that the brand uses. |
sending | string | Optional | The URI for the sending resource file that the brand uses. |
signing | string | Optional | The URI for the signing resource file that the brand uses. |
signingCaptive | string | Optional | The URI for the captive (embedded) signing resource file that the brand uses. |
Updates an existing template — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accessControlListBase64 | string | Optional | Reserved for Docusign. |
allowComments | string | Optional | When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document. |
allowMarkup | string | Optional | When **true,** the Document Markup feature is enabled. **Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level. |
allowReassign | string | Optional | When **true,** the recipient can redirect an envelope to a more appropriate recipient. |
allowViewHistory | string | Optional | When **true,** recipients can view the history of the envelope. |
anySigner | string | Optional | Deprecated. This feature has been replaced by signing groups. |
asynchronous | string | Optional | When **true,** the envelope is queued for processing and the value of the `status` property is set to `Processing`. Additionally, GET status calls return `Processing` until completed. **Note:** A `transactionId` is required for this call to work correctly. When the envelope is created, the status is `Processing` and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query by using the [transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the Connect notification. |
attachmentsUri | string | Optional | Contains a URL for retrieving the attachments that are associated with the envelope. |
authoritativeCopy | string | Optional | When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** |
authoritativeCopyDefault | string | Optional | The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope's `authoritativeCopy`. |
autoMatch | string | Optional | By default, templates that have been used within the last 60 days are included in auto-matching. By explicitly setting `autoMatch`, you can permanently include or exclude the template in auto matching. When **true** the template is included in auto-matching regardless of when it was last used. When **false** the template is never included in auto-matching. |
autoMatchSpecifiedByUser | string | Optional | When **true,** the template has been explicitly included in or excluded from auto-matching. The default is false. This is a read-only property. |
autoNavigation | string | Optional | When **true,** autonavigation is set for the recipient. |
brandId | string | Optional | The ID of the brand. |
brandLock | string | Optional | When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. |
burnDefaultTabData | string | Optional | |
certificateUri | string | Optional | The URI for retrieving certificate information. |
completedDateTime | string | Optional | Specifies the date and time this item was completed. |
copyRecipientData | string | Optional | |
created | string | Optional | The UTC DateTime when the workspace user authorization was created. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customFields | Model | Optional | Expand Gets a list of custom fields — response body An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters. |
customFieldsUri | string | Optional | The URI for retrieving custom fields. |
declinedDateTime | string | Optional | The date and time the recipient declined the document. This property is read-only. |
deletedDateTime | string | Optional | Reserved for Docusign. |
deliveredDateTime | string | Optional | The date and time that the envelope was delivered to the recipient. This property is read-only. |
description | string | Optional | A sender-defined description of the line item. |
disableResponsiveDocument | string | Optional | When **true,** responsive documents are disabled for the envelope. |
documentBase64 | string | Optional | The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. |
documents | array | Optional | A complex element that contains details about the documents associated with the envelope. |
documents[] | Model | Each item | Expand Creates an envelope — request body — body documents item |
documentsCombinedUri | string | Optional | The URI for retrieving all of the documents associated with the envelope as a single PDF file. |
documentsUri | string | Optional | The URI for retrieving all of the documents associated with the envelope as separate files. |
emailBlurb | string | Optional | This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients. |
emailSettings | Model | Optional | Expand Adds email setting overrides to an envelope — response body A complex type that contains email settings. |
emailSubject | string | Optional | The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. |
enableWetSign | string | Optional | When **true,** the signer is allowed to print the document and sign it on paper. |
enforceSignerVisibility | string | Optional | When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting. **Note:** To use this functionality, [document visibility][docviz] must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support][support] or your account manager to find out whether document visibility is available for your production account plan. [docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/ [sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending [fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html [support]: https://support.docusign.com/en/contactSupport# |
envelopeAttachments | array | Optional | An array of attachment objects that provide information about the attachments that are associated with the envelope. |
envelopeAttachments[] | Model | Each item | Expand Updates an envelope attachment in a draft or in-process envelope — request body — body |
envelopeCustomMetadata | Model | Optional | Expand Gets the status of a single envelope — response body — envelope Custom Metadata |
envelopeDocuments | array | Optional | An array containing information about the documents that are included in the envelope. |
envelopeDocuments[] | Model | Each item | Expand Updates a template document — response body |
envelopeId | string | Optional | The envelope ID of an envelope that you want to use as the basis for the template. The state of the envelope can be `draft`, `sent`, or `completed`. |
envelopeIdStamping | string | Optional | When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed. |
envelopeLocation | string | Optional | Reserved for Docusign. |
envelopeMetadata | Model | Optional | Expand Gets the status of a single envelope — response body — envelope Metadata Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and Docusign eNotary service. |
envelopeUri | string | Optional | The URI for retrieving the envelope or envelopes. |
expireAfter | string | Optional | Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. |
expireDateTime | string | Optional | Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. |
expireEnabled | string | Optional | Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. |
externalEnvelopeId | string | Optional | May contain an external identifier for the envelope. |
favoritedByMe | string | Optional | |
folderId | string | Optional | The ID of the folder. |
folderIds | array | Optional | |
folderIds[] | string | Each item | |
folderName | string | Optional | |
folders | array | Optional | A list of folder objects. |
folders[] | Model | Each item | Expand Creates an envelope — request body — body folders item |
hasComments | string | Optional | When **true,** indicates that users have added comments to the envelope. |
hasFormDataChanged | string | Optional | When **true,** indicates that the data collected through form fields on a document has changed. |
hasWavFile | string | Optional | When **true,** indicates that a .wav file used for voice authentication is included in the envelope. |
holder | string | Optional | Reserved for Docusign. |
initialSentDateTime | string | Optional | The date and time the envelope was initially sent. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
isAceGenTemplate | string | Optional | |
isDocGenTemplate | string | Optional | |
isDynamicEnvelope | string | Optional | When **true,** indicates that the envelope is a dynamic envelope. |
isSignatureProviderEnvelope | string | Optional | When **true,** indicates that the envelope is a signature-provided envelope. |
isTicketRelatedEnvelope | string | Optional | |
lastModified | string | Optional | The UTC date and time that the comment was last updated. **Note:** This can only be done by the creator. |
lastModifiedBy | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
lastUsed | string | Optional | |
location | string | Optional | Reserved for Docusign. |
lockInformation | Model | Optional | Expand Locks an envelope — response body Provides lock information about an envelope that a user has locked. |
messageLock | string | Optional | When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. |
name | string | Optional | |
newPassword | string | Optional | The user's new password. |
notification | Model | Optional | Expand Gets envelope notification information — response body |
notificationUri | string | Optional | The URI for retrieving notifications. |
owner | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the template. |
pageCount | string | Optional | An integer value specifying the number of document pages in the template. |
password | string | Optional | The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. |
passwordProtected | string | Optional | |
powerForm | Model | Optional | Expand Creates a new Power Form — request body — body Information about any PowerForms that are included in the envelope. |
powerForms | array | Optional | An array of PowerForm objects. |
powerForms[] | Model | Each item | Expand Creates a new Power Form — request body — body |
purgeCompletedDate | string | Optional | The date that a purge was completed. |
purgeRequestDate | string | Optional | The date that a purge was requested. |
purgeState | string | Optional | Shows the current purge state for the envelope. Valid values: - `unpurged`: There has been no successful request to purge documents. - `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. - `documents_dequeued`: The envelope documents have been taken out of the purge queue. - `documents_purged`: The envelope documents have been successfully purged. - `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. - `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted. - `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted. **Related topics** - [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/) - [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope) |
recipients | Model | Optional | Expand Deletes recipients from an envelope — request body — body An array of recipient objects that provides details about the recipients of the envelope. |
recipientsLock | string | Optional | When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope. |
recipientsUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the recipients. |
sender | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the sender of the envelope. |
sentDateTime | string | Optional | The UTC DateTime when the envelope was sent. This property is read-only. |
shared | string | Optional | When **true,** indicates the template is shared with the **Everyone** group, which includes all users on the account. When **false,** the template is shared only with the groups you specify. |
signerCanSignOnMobile | string | Optional | When **true,** recipients can sign on a mobile device. **Note:** Only Admin users can change this setting. |
signingLocation | string | Optional | Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. |
status | string | Optional | Indicates the envelope status. Valid values are: * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. * `created`: The envelope is created as a draft. It can be modified and sent later. * `declined`: The envelope has been declined by the recipients. * `delivered`: The envelope has been delivered to the recipients. * `sent`: The envelope will be sent to the recipients after the envelope is created. * `signed`: The envelope has been signed by the recipients. * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. |
statusChangedDateTime | string | Optional | The data and time that the status changed. |
templateId | string | Optional | The unique identifier of the template. If this is not provided, Docusign will generate a value. |
templatesUri | string | Optional | The URI for retrieving the templates. |
transactionId | string | Optional | Used to identify an envelope. The ID is a sender-generated value and is valid in the Docusign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet c onnection was lost before the envelope status was returned. |
uSigState | string | Optional | |
uri | string | Optional | A URI containing the user ID. |
useDisclosure | string | Optional | When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. |
voidedDateTime | string | Optional | The date and time the envelope or template was voided. |
voidedReason | string | Optional | The reason the envelope or template was voided. **Note:** The string is truncated to the first 200 characters. |
workflow | Model | Optional | Expand Returns the workflow definition for a template — response body |
Referenced models: Gets a list of custom fields — response body, Locks an envelope — response body, Updates an envelope attachment in a draft or in-process envelope — request body — body, Adds email setting overrides to an envelope — response body, Gets the status of a single envelope — response body — envelope Custom Metadata, Updates a template document — response body, Gets the status of a single envelope — response body — envelope Metadata, Gets envelope notification information — response body, Gets a specific template associated with a specified account — response body — owner, Returns the workflow definition for a template — response body, Deletes recipients from an envelope — request body — body, Creates an envelope — request body — body documents item, Creates an envelope — request body — body folders item, Creates a new Power Form — request body — body
Updates an existing template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bulkEnvelopeStatus | Model | Optional | Expand Creates an envelope — response body — bulk Envelope Status An object that describes the status of the bulk send envelopes. |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
listCustomFieldUpdateResults | array | Optional | |
listCustomFieldUpdateResults[] | Model | Each item | Expand Gets a list of custom fields — response body — list Custom Fields item |
lockInformation | Model | Optional | Expand Locks an envelope — response body Provides lock information about an envelope that a user has locked. |
purgeState | string | Optional | Shows the current purge state for the envelope. Valid values: - `unpurged`: There has been no successful request to purge documents. - `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. - `documents_dequeued`: The envelope documents have been taken out of the purge queue. - `documents_purged`: The envelope documents have been successfully purged. - `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. - `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted. - `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted. **Related topics** - [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/) - [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope) |
recipientUpdateResults | array | Optional | An array of `recipientUpdateResults` objects that contain details about the recipients. |
recipientUpdateResults[] | Model | Each item | Expand Updates an existing template — response body — recipient Update Results item |
tabUpdateResults | Model | Optional | Expand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body |
textCustomFieldUpdateResults | array | Optional | |
textCustomFieldUpdateResults[] | Model | Each item | Expand Gets a list of custom fields — response body — text Custom Fields item |
Referenced models: Locks an envelope — response body, Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, Creates an envelope — response body — bulk Envelope Status, Locks a template — response body — error Details, Gets a list of custom fields — response body — list Custom Fields item, Updates an existing template — response body — recipient Update Results item, Gets a list of custom fields — response body — text Custom Fields item
Updates an existing template — response body — recipient Update Results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The recipient details that are returned after you update the recipient. |
combined | string | Optional | When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When **true,** it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
recipientId | string | Optional | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
tabs | Model | Optional | Expand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body All of the tabs associated with the recipient. |
Referenced models: Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, Locks a template — response body — error Details
Updates document visibility for recipients — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of `documentVisibility` objects that specify whether documents are visible to recipients. |
documentVisibility | array | Optional | An array of `documentVisibility` objects that specifies which documents are visible to which recipients. |
documentVisibility[] | Model | Each item | Expand Updates document visibility for recipients — response body — document Visibility item |
Referenced models: Updates document visibility for recipients — response body — document Visibility item
Updates document visibility for recipients — response body — document Visibility item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object configures a recipient's read/write access to a document. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
recipientId | string | Optional | The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object. |
rights | string | Optional | Indicates whether the document is editable: - `editable` - `read_only` |
visible | string | Optional | When **true,** the document is visible to the recipient. |
Referenced models: Locks a template — response body — error Details
Updates document visibility for template recipients — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients. |
documentVisibility | array | Optional | An array of `documentVisibility` objects that specifies which documents are visible to which recipients. |
documentVisibility[] | Model | Each item | Expand Updates document visibility for recipients — response body — document Visibility item |
Referenced models: Updates document visibility for recipients — response body — document Visibility item
Updates envelope custom fields in an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like "eVault with eOriginal?" to "Yes" or "No". When a user creates an envelope, the envelope custom fields display in the **Envelope Settings** section of the Docusign console. Envelope recipients do not see the envelope custom fields. For more information, see [Envelope Custom Fields](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html). |
listCustomFields | array | Optional | An array of list custom fields. |
listCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — list Custom Fields item |
textCustomFields | array | Optional | An array of text custom fields. |
textCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — text Custom Fields item |
Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item
Updates one or more contacts — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request object containing the new information for the contacts. |
contactList | array | Optional | A list of contacts. |
contactList[] | Model | Each item | Expand Deletes a contact — response body — contacts item |
Referenced models: Deletes a contact — response body — contacts item