Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootDocument tabs are tabs that are associated with a document rather than with a recipient.
approveTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — approve Tabs item
checkboxTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — checkbox Tabs item
commentThreadTabsarrayOptionalAn 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[]ModelEach itemExpand Returns tabs on a template — response body — comment Thread Tabs item
commissionCountyTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — commission County Tabs item
commissionExpirationTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — commission Expiration Tabs item
commissionNumberTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — commission Number Tabs item
commissionStateTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — commission State Tabs item
companyTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — company Tabs item
dateSignedTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — date Signed Tabs item
dateTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — date Tabs item
declineTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — decline Tabs item
drawTabsarrayOptionalA list of Draw Tabs.

A Draw Tab allows the recipient to add a free-form drawing to the document.
drawTabs[]ModelEach itemExpand Returns tabs on a template — response body — draw Tabs item
emailAddressTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — email Address Tabs item
emailTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — email Tabs item
envelopeIdTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — envelope Id Tabs item
firstNameTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — first Name Tabs item
formulaTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — formula Tabs item
fullNameTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — full Name Tabs item
initialHereTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — initial Here Tabs item
lastNameTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — last Name Tabs item
listTabsarrayOptionalAn 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[]ModelEach itemExpand Returns tabs on a template — response body — list Tabs item
notarizeTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — notarize Tabs item
notarySealTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — notary Seal Tabs item
noteTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — note Tabs item
numberTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — number Tabs item
numericalTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — numerical Tabs item
phoneNumberTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — phone Number Tabs item
polyLineOverlayTabsarrayOptionalThis type of tab enables the recipient to strike through document text. This value can't be set.
polyLineOverlayTabs[]ModelEach itemExpand Returns tabs on a template — response body — poly Line Overlay Tabs item
prefillTabsModelOptionalExpand 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
radioGroupTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — radio Group Tabs item
signHereTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — sign Here Tabs item
signerAttachmentTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — signer Attachment Tabs item
smartSectionTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — smart Section Tabs item
ssnTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — ssn Tabs item
tabGroupsarrayOptionalAn 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[]ModelEach itemExpand Returns tabs on a template — response body — tab Groups item
textTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — text Tabs item
titleTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — title Tabs item
viewTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — view Tabs item
zipTabsarrayOptionalA 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootA complex object describing a user authorization.
agentUserModelOptionalExpand esignature:Envelopes Shares Get Envelopes Share — response body — agent User
The user who can act on behalf of the principal user.
authorizationIdstringOptionalThe ID of the user authorization.
createdstringOptionalThe UTC DateTime when the workspace user authorization was created.
createdBystringOptionalThe name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`
endDatestringOptionalThe UTC DateTime at which the authorization will expire.
modifiedstringOptionalThe UTC DateTime when the workspace user authorization was last updated.
modifiedBystringOptionalThe name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`
permissionstringOptionalThe [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.
principalUserModelOptionalExpand esignature:Envelopes Shares Get Envelopes Share — response body — agent User
The user for whom the agent user acts.
startDatestringOptionalThe UTC DateTime at which the authorization will start.
taskSourcestringOptional
taskTypestringOptional

Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body — agent User

Returns the workflow definition for a template — response body

FieldTypePresenceDescription and constraints
$objectRootDescribes the workflow for an envelope.
currentWorkflowStepIdstringOptionalThe `workflowStepId` of the current step.
This is not an index into the `workflowSteps` array in this object.
See the `workflowStep` object.
resumeDatestringOptionalThe 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.
scheduledSendingModelOptionalExpand Updates the scheduled sending rules for an envelope's workflow — response body
An object that describes the settings for scheduled sending.
workflowStatusstringOptionalThe status of the workflow:

- `paused` if the workflow is paused
- `in_progress` if the workflow is in progress
workflowStepsarrayOptionalAn array of workflow steps.
workflowSteps[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
allUsersSelectedstringOptional
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
usersarrayOptionalUser management information.
users[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe request body for the [EnvelopeViews: createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/) method.
beginOnTaggerstringOptional
returnUrlstringOptional(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.
suppressNavigationstringOptionalSpecifies whether the window is displayed with or without dressing.
viewUrlstringOptional

Send, void, or modify a draft envelope Purge documents from a completed envelope — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accessControlListBase64stringOptionalReserved for Docusign.
allowCommentsstringOptionalWhen **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.
allowMarkupstringOptionalWhen **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.
allowReassignstringOptionalWhen **true,** the recipient can redirect an envelope to a more appropriate recipient.
allowViewHistorystringOptionalWhen **true,** recipients can view the history of the envelope.
anySignerstringOptionalDeprecated. This feature has been replaced by signing groups.
asynchronousstringOptionalWhen **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.
attachmentsUristringOptionalContains a URL for retrieving the attachments that are associated with the envelope.
authoritativeCopystringOptionalWhen **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.**
authoritativeCopyDefaultstringOptionalThe 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`.
autoNavigationstringOptionalWhen **true,** autonavigation is set for the recipient.
brandIdstringOptionalThe ID of the brand.
brandLockstringOptionalWhen **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.
burnDefaultTabDatastringOptional
certificateUristringOptionalThe URI for retrieving certificate information.
completedDateTimestringOptionalSpecifies the date and time this item was completed.
copyRecipientDatastringOptional
createdDateTimestringOptionalThe UTC DateTime when the item was created.
customFieldsModelOptionalExpand 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.
customFieldsUristringOptionalThe URI for retrieving custom fields.
declinedDateTimestringOptionalThe date and time the recipient declined the document. This property is read-only.
deletedDateTimestringOptionalReserved for Docusign.
deliveredDateTimestringOptionalThe date and time that the envelope was delivered to the recipient. This property is read-only.
disableResponsiveDocumentstringOptionalWhen **true,** responsive documents are disabled for the envelope.
documentBase64stringOptionalThe 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.
documentsCombinedUristringOptionalThe URI for retrieving all of the documents associated with the envelope as a single PDF file.
documentsUristringOptionalThe URI for retrieving all of the documents associated with the envelope as separate files.
emailBlurbstringOptionalThis is the same as the email body. If specified it is included in email body for all envelope recipients.
emailSettingsModelOptionalExpand Adds email setting overrides to an envelope — response body
A complex type that contains email settings.
emailSubjectstringOptionalThe 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.
enableWetSignstringOptionalWhen **true,** the signer is allowed to print the document and sign it on paper.
enforceSignerVisibilitystringOptionalWhen **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#
envelopeAttachmentsarrayOptionalAn array of attachment objects that provide information about the attachments that are associated with the envelope.
envelopeAttachments[]ModelEach itemExpand Updates an envelope attachment in a draft or in-process envelope — request body — body
envelopeCustomMetadataModelOptionalExpand Gets the status of a single envelope — response body — envelope Custom Metadata
envelopeDocumentsarrayOptionalAn array containing information about the documents that are included in the envelope.
envelopeDocuments[]ModelEach itemExpand Updates a template document — response body
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
envelopeIdStampingstringOptionalWhen **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.
envelopeLocationstringOptionalReserved for Docusign.
envelopeMetadataModelOptionalExpand 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.
envelopeUristringOptionalThe URI for retrieving the envelope or envelopes.
expireAfterstringOptionalNot 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.
expireDateTimestringOptionalThe 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.)
expireEnabledstringOptionalNot 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.
externalEnvelopeIdstringOptionalMay contain an external identifier for the envelope.
foldersarrayOptionalA list of folder objects.
folders[]ModelEach itemExpand Creates an envelope — request body — body folders item
hasCommentsstringOptionalWhen **true,** indicates that users have added comments to the envelope.
hasFormDataChangedstringOptionalWhen **true,** indicates that the data collected through form fields on a document has changed.
hasWavFilestringOptionalWhen **true,** indicates that a .wav file used for voice authentication is included in the envelope.
holderstringOptionalReserved for Docusign.
initialSentDateTimestringOptionalThe date and time the envelope was initially sent.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
isDynamicEnvelopestringOptionalWhen **true,** indicates that the envelope is a dynamic envelope.
isSignatureProviderEnvelopestringOptionalWhen **true,** indicates that the envelope is a signature-provided envelope.
isTicketRelatedEnvelopestringOptional
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
locationstringOptionalReserved for Docusign.
lockInformationModelOptionalExpand Locks an envelope — response body
Provides lock information about an envelope that a user has locked.
messageLockstringOptionalWhen **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.
notificationModelOptionalExpand Gets envelope notification information — response body
notificationUristringOptionalThe URI for retrieving notifications.
powerFormModelOptionalExpand Creates a new Power Form — request body — body
Information about any PowerForms that are included in the envelope.
purgeCompletedDatestringOptionalThe date that a purge was completed.
purgeRequestDatestringOptionalThe date that a purge was requested.
purgeStatestringOptionalShows 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)

recipientsModelOptionalExpand Deletes recipients from an envelope — request body — body
An array of recipient objects that provides details about the recipients of the envelope.
recipientsLockstringOptionalWhen **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope.
recipientsUristringOptionalContains a URI for an endpoint that you can use to retrieve the recipients.
senderModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the sender of the envelope.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
signerCanSignOnMobilestringOptionalWhen **true,** recipients can sign on a mobile device.

**Note:** Only Admin users can change this setting.
signingLocationstringOptionalSpecifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.
statusstringOptionalIndicates 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.
statusChangedDateTimestringOptionalThe data and time that the status changed.
templatesUristringOptionalThe URI for retrieving the templates.
transactionIdstringOptionalUsed 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.
uSigStatestringOptional
useDisclosurestringOptionalWhen **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.
voidedDateTimestringOptionalThe date and time the envelope or template was voided.
voidedReasonstringOptionalThe reason the envelope or template was voided.

**Note:** The string is truncated to the first 200 characters.
workflowModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
favoriteTemplatesarrayOptionalThe favorite templates acted upon by the call.
favoriteTemplates[]ModelEach itemExpand Set one or more templates as account favorites — response body — favorite Templates item
templatesUpdatedCountintegerOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
favoriteTemplatesarrayOptionalThe favorite templates acted upon by the call.
favoriteTemplates[]ModelEach itemExpand Set one or more templates as account favorites — response body — favorite Templates item
templatesUpdatedCountJSONOptional
templatesUpdatedCount (anyOf 1)integerAlternativeThe number of templates successfully updated by the call. This property is read-only.
Format: int32
templatesUpdatedCount (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
favoritedDatestringOptionalTime at which the template was marked as favorite.
templateIdstringOptionalThe ID of the template.

Referenced models: Locks a template — response body — error Details

Set up Connect O Auth for the specified account — response body

FieldTypePresenceDescription and constraints
$objectRootA complex object describing a Connect OAuth configuration.
authorizationServerUrlstringOptionalThe token URL for your authorization server or OAuth service.

This property is required.
clientIdstringOptionalThe client ID assigned to your app by your authorization server or OAuth service.

This property is required.
clientSecretstringOptionalThe secret value provided by your authorization server.

This property is required.
customParametersobjectOptionalAdditional keys: see wildcard field
customParameters.*stringAdditional keys
scopestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe request body for the `createHistoricalEnvelopePublishTransaction` endpoint.
configModelOptionalExpand 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.
envelopesarrayOptionalAn 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[]stringEach item

Referenced models: Creates a Connect configuration — response body

Submits a batch of historical envelopes for republish to a webhook — response body

FieldTypePresenceDescription and constraints
$objectRoot
applyConnectSettingsstringOptional
envelopeCountstringOptional
envelopeLevelErrorRollupsarrayOptional
envelopeLevelErrorRollups[]ModelEach itemExpand Submits a batch of historical envelopes for republish to a webhook — response body — envelope Level Error Rollups item
envelopePublishTransactionIdstringOptionalThe ID of the publish transaction.
errorCountstringOptional
fileLevelErrorsarrayOptional
fileLevelErrors[]stringEach item
noActionRequiredEnvelopeCountstringOptional
processedEnvelopeCountstringOptional
processingStatusstringOptionalThe status of the transaction. Valid values:

* `unprocessed`
* `processing`
* `complete`
* `fatal_error`
resultsUristringOptional
submissionDatestringOptional
submittedByUserInfoModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
submittedForPublishingEnvelopeCountstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
countstringOptionalThe maximum number of results to return.
errorTypestringOptional

Updates a branding resource file — response body

FieldTypePresenceDescription and constraints
$objectRootInformation about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.
createdByUserInfoModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
The user ID of the user who created the brand resource.
createdDatestringOptionalThe date and time that the brand resource was created.
dataNotSavedNotInMasterarrayOptionalDeprecated.
dataNotSavedNotInMaster[]stringEach item
modifiedByUserInfoModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who last modified the brand resource.
modifiedDatestringOptionalThe date on which this user record was last modified.
modifiedTemplatesarrayOptionalThis 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[]stringEach item
resourcesContentTypestringOptionalThe 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.
resourcesContentUristringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootContains 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.
createdstringOptionalThe UTC DateTime when the signing group was created. This property is read-only.
createdBystringOptionalThe name of the user who created the signing group. This property is read-only.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
groupEmailstringOptionalThe email address for the signing group. You can use a group email address to email all of the group members at the same time.
groupNamestringOptionalThe name of the group.
groupTypestringOptionalThe type of the group. The only valid value for this request is `sharedSigningGroup`.
modifiedstringOptionalThe UTC DateTime when the signing group was last modified. This property is read-only.
modifiedBystringOptionalThe user ID (GUID) of the user who last modified this user record. This property is read-only.
signingGroupIdstringOptionalThe ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).
usersarrayOptionalUser management information.
users[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptional
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
userNamestringOptionalThe name of the group member.

Maximum Length: 100 characters.

Referenced models: Locks a template — response body — error Details

Updates a template document — response body

FieldTypePresenceDescription and constraints
$objectRootThis object contains details about the envelope document.
addedRecipientIdsarrayOptionalIf recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only.
addedRecipientIds[]stringEach item
agreementTypestringOptional
agreementTypeSourcestringOptional
attachmentTabIdstringOptionalIf 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.
authoritativeCopystringOptionalWhen **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.**
authoritativeCopyMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.
availableDocumentTypesarrayOptional
availableDocumentTypes[]ModelEach itemExpand Updates a template document — response body — available Document Types item
containsPdfFormFieldsstringOptionalWhen **true,** the document has editable form fields that are made available through a PDF format.
displaystringOptionalThis 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.
displayMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.
docGenDocumentStatusstringOptional
docGenErrorsarrayOptional
docGenErrors[]ModelEach itemExpand Updates a template document — response body — doc Gen Errors item
docGenFormFieldsarrayOptional
docGenFormFields[]ModelEach itemExpand Updates a template document — response body — doc Gen Form Fields item
documentBase64stringOptionalThe 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.
documentFieldsarrayOptionalAn object containing information about the custom fields on the document.
documentFields[]ModelEach itemExpand Updates an existing brand — response body — colors item
documentIdstringOptionalThe ID of the document that the tab is placed on. This value must refer to the ID of an existing document.
documentIdGuidstringOptionalThe GUID of the document.
documentTemplateIdstringOptional
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
hasDigitalSignaturestringOptional
includeInDownloadstringOptionalWhen **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.**
includeInDownloadMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.
isAceGenDocumentstringOptional
isDocGenDocumentstringOptional
isEditedstringOptional
isExternallyAvailablestringOptional
isFlattenedstringOptional
namestringOptionalThe document's file name.

Example: `Q1-Report.docx`
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.
orderstringOptionalThe order in which to sort the results.

Valid values are:


* `asc`: Ascending order.
* `desc`: Descending order.
pagesarrayOptionalAn array of page objects that contain information about the pages in the document.
pages[]ModelEach itemExpand Creates a workspace file — response body — thumbnail
signerMustAcknowledgestringOptionalSets 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.

signerMustAcknowledgeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.
sizeBytesstringOptional
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
typestringOptionalThe 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`
uristringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThis object contains information about the type of signature.
isDefaultstringOptionalWhen **true,** the signature type is the default type.
typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootDescribes document generation errors.
errorCodestringOptionalA code associated with the error condition.
messagestringOptionalThe error message.
tagIdentifierstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThe 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.
connectedObjectDetailsModelOptionalExpand Returns tabs on a template — response body — ssn Tabs item connected Object Details
defaultValuestringOptional
descriptionstringOptionalA description of the field. Displayed with the label.
filterstringOptionalAn object used to present a filtered view of the items in a folder.
formatModelOptionalExpand Updates a template document — response body — doc Gen Form Fields item format
fullyQualifiedPathstringOptional
hiddenstringOptional
labelstringOptionalA label displayed near the field.
namestringOptionalThe name of the sender field.

Required for PUT requests.
optionsarrayOptionalWhen `type` is `Select`, this array describes the available options.
options[]ModelEach itemExpand Updates a template document — response body — doc Gen Form Fields item options item
orderstringOptionalThe order in which to sort the results.

Valid values are:


* `asc`: Ascending order.
* `desc`: Descending order.
predefinedValidationstringOptionalReserved for Docusign.
readOnlystringOptional
requiredstringOptionalWhen **true,** the field is required.
rowValuesarrayOptionalFor 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[]ModelEach itemExpand Updates a template document — response body — doc Gen Form Fields item row Values item
typestringOptionalThe kind of data the sender field holds. Valid values:

- `TextBox`
- `Date`
- `Number`
- `Select`
- `TableRow`
validationModelOptionalExpand Updates a template document — response body — doc Gen Form Fields item validation
Describes how values are validated.
valuestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
expressionstringOptional
localestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootSpecifies an individual option setting when type is `Select`.
descriptionstringOptionalDescription of the selectable option.
labelstringOptionalThe label for the selectable option.
selectedstringOptionalWhen **true,** the option is selected.
valuestringOptionalSpecifies 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

FieldTypePresenceDescription and constraints
$objectRootAn object representing a row of a dynamic table.
docGenFormFieldListarrayOptionalThe 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootDescribes how values are validated.
errorMessagestringOptionalThe error message when validation fails.
expressionstringOptionalThe expression used to validate values.

Updates a template document — response body — name Metadata

FieldTypePresenceDescription and constraints
$objectRootMetadata about a property.
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item
rightsstringOptionalIndicates whether the property is editable. Valid values are:

- `editable`
- `read_only`

Updates an account billing plan — request body — body

FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a billing plan.
appStoreReceiptModelOptionalExpand Updates an account billing plan — request body — body app Store Receipt
billingAddressModelOptionalExpand Get Account Billing Plan — response body — billing Address
The billing address for the account.
creditCardInformationModelOptionalExpand Get credit card information — response body
A complex type that has information about the credit card used to pay for this account.
directDebitProcessorInformationModelOptionalExpand Get Account Billing Plan — response body — direct Debit Processor Information
Information about the bank that processes direct debits for the payment plan.
downgradeReasonstringOptional(Optional) The user's reason for downgrading their billing plan.
enablePreAuthstringOptional
enableSupportstringOptionalWhen **true,** customer support is provided as part of the account plan.
includedSeatsstringOptionalThe number of seats (users) included in the plan.
incrementalSeatsstringOptionalReserved for Docusign.
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

- `NotSupported`
- `CreditCard`
- `PurchaseOrder`
- `Premium`
- `Freemium`
- `FreeTrial`
- `AppStore`
- `DigitalExternal`
- `DirectDebit`
paymentProcessorstringOptional
paymentProcessorInformationModelOptionalExpand Get Account Billing Plan — response body — payment Processor Information
Information about the entity that processes payments for the billing plan.
planInformationModelOptionalExpand Updates an account billing plan — request body — body plan Information
An object used to identify the features and attributes of the account being created.
processPaymentstringOptional
referralInformationModelOptionalExpand Get Account Billing Plan — response body — referral Information
A complex type that contains properties for entering referral and discount information.
renewalStatusstringOptionalThe 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`.
saleDiscountAmountstringOptionalReserved for Docusign.
saleDiscountFixedAmountstringOptionalReserved for Docusign.
saleDiscountPercentstringOptionalReserved for Docusign.
saleDiscountPeriodsstringOptionalReserved for Docusign.
saleDiscountSeatPriceOverridestringOptionalReserved for Docusign.
taxExemptIdstringOptional

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

FieldTypePresenceDescription and constraints
$objectRootContains information about an APP store receipt.
downgradeProductIdstringOptional
isDowngradeCancellationstringOptional
productIdstringOptionalThe Product ID from the AppStore.
receiptDatastringOptionalReserved for Docusign.

Updates an account billing plan — request body — body plan Information

FieldTypePresenceDescription and constraints
$objectRootAn object used to identify the features and attributes of the account being created.
addOnsarrayOptionalReserved for Docusign.
addOns[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan add Ons item
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
freeTrialDaysOverridestringOptionalReserved for Docusign.
planFeatureSetsarrayOptionalReserved for Docusign.
planFeatureSets[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan plan Feature Sets item
planIdstringOptionalDocusign's ID for the account plan.
recipientDomainsarrayOptional
recipientDomains[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootDefines a billing plan update response object.
accountPaymentMethodstringOptionalThe type of payment method used for the account. Valid values are:

- `credit_card`
-
billingPlanPreviewModelOptionalExpand Updates an account billing plan — response body — billing Plan Preview
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
includedSeatsstringOptionalThe number of seats (users) included in the plan.
paymentCyclestringOptionalThe payment cycle associated with the plan. Valid values:

- `Monthly`
- `Annually`
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

- `NotSupported`
- `CreditCard`
- `PurchaseOrder`
- `Premium`
- `Freemium`
- `FreeTrial`
- `AppStore`
- `DigitalExternal`
- `DirectDebit`
planIdstringOptionalDocusign's ID for the account plan.
planNamestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootInformation used to provide a preview of a billing plan.
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
invoiceModelOptionalExpand Retrieves a billing invoice — response body
isProratedstringOptionalWhen **true,** the billing plan is prorated.
subtotalAmountstringOptional
taxAmountstringOptional
totalAmountstringOptional

Referenced models: Retrieves a billing invoice — response body

Updates an envelope attachment in a draft or in-process envelope — request body — body

FieldTypePresenceDescription and constraints
$objectRootContains information about an attachment.
accessControlstringOptionalValid values are `sender` and `senderAndAllRecipients`.
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient.
datastringOptionalA 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.
labelstringOptionalA 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.
namestringOptionalThe name of the attachment.
remoteUrlstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootInformation about a brand that is associated with an account. A brand applies custom styles and text to an envelope.
brandCompanystringOptionalThe name of the company associated with the brand.
brandIdstringOptionalThe ID used to identify a specific brand in API calls.
brandLanguagesarrayOptionalAn 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[]stringEach item
brandNamestringOptionalThe name of the brand.
colorsarrayOptionalAn 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[]ModelEach itemExpand Updates an existing brand — response body — colors item
defaultBrandLanguagestringOptionalThe 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`)
emailContentarrayOptionalDeprecated.
emailContent[]ModelEach itemExpand Updates an existing brand — response body — email Content item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
isOrganizationBrandstringOptional
isOverridingCompanyNamebooleanOptionalWhen **true,** the `brandCompany` property is overriding the name of the company in the account settings.
isSendingDefaultbooleanOptionalWhen **true,** the sending brand is the default brand for sending new envelopes.
isSigningDefaultbooleanOptionalWhen **true,** the siging brand is the default brand for the signing experience.
landingPagesarrayOptionalAn 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[]ModelEach itemExpand Updates an existing brand — response body — colors item
linksarrayOptionalAn array of `brandLink` objects that contain information about the links that the brand uses.
links[]ModelEach itemExpand Updates an existing brand — response body — links item
logoIdsModelOptionalExpand Updates an existing brand — response body — logo Ids
logosModelOptionalExpand Updates an existing brand — response body — logos
The URIs for retrieving the logos that are associated with the brand.
organizationBrandLogostringOptional
resourcesModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootA name-value pair that describes an item and provides a value for the item.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
namestringOptionalThe name of the item.
originalValuestringOptionalThe initial value of the item.
valuestringOptionalThe current value of the item.

Referenced models: Locks a template — response body — error Details

Updates an existing brand — response body — email Content item

FieldTypePresenceDescription and constraints
$objectRootDeprecated.
contentstringOptionalDeprecated.
emailContentTypestringOptionalDeprecated.
emailToLinkstringOptionalDeprecated.
linkTextstringOptionalDeprecated.

Updates an existing brand — response body — links item

FieldTypePresenceDescription and constraints
$objectRootInformation about a link that a brand uses.
linkTextstringOptionalThe text used for the link.
linkTypestringOptionalThe type of link. Valid values include:

- `aboutDocusign`
- `closeButton`
showLinkstringOptionalWhen **true,** the link displays to the recipient.
urlOrMailTostringOptionalThe URL or mailto address of the link.

Updates an existing brand — response body — logo Ids

FieldTypePresenceDescription and constraints
$objectRoot
emailLogoIdstringOptional
primaryLogoIdstringOptional
secondaryLogoIdstringOptional

Updates an existing brand — response body — logos

FieldTypePresenceDescription and constraints
$objectRootThe 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/).
emailstringOptionalThe 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/).
primarystringOptionalThe 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/).
secondarystringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootBrands use resource files to style the following experiences:

- Email
- Sending
- Signing
- Captive (embedded) signing

You can modify these resource files to customize these experiences.
emailstringOptionalThe URI for the email resource file that the brand uses.
sendingstringOptionalThe URI for the sending resource file that the brand uses.
signingstringOptionalThe URI for the signing resource file that the brand uses.
signingCaptivestringOptionalThe URI for the captive (embedded) signing resource file that the brand uses.

Updates an existing template — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accessControlListBase64stringOptionalReserved for Docusign.
allowCommentsstringOptionalWhen **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.
allowMarkupstringOptionalWhen **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.
allowReassignstringOptionalWhen **true,** the recipient can redirect an envelope to a more appropriate recipient.
allowViewHistorystringOptionalWhen **true,** recipients can view the history of the envelope.
anySignerstringOptionalDeprecated. This feature has been replaced by signing groups.
asynchronousstringOptionalWhen **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.
attachmentsUristringOptionalContains a URL for retrieving the attachments that are associated with the envelope.
authoritativeCopystringOptionalWhen **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.**
authoritativeCopyDefaultstringOptionalThe 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`.
autoMatchstringOptionalBy 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.
autoMatchSpecifiedByUserstringOptionalWhen **true,** the template has been explicitly included in or excluded from auto-matching. The default is false.
This is a read-only property.
autoNavigationstringOptionalWhen **true,** autonavigation is set for the recipient.
brandIdstringOptionalThe ID of the brand.
brandLockstringOptionalWhen **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.
burnDefaultTabDatastringOptional
certificateUristringOptionalThe URI for retrieving certificate information.
completedDateTimestringOptionalSpecifies the date and time this item was completed.
copyRecipientDatastringOptional
createdstringOptionalThe UTC DateTime when the workspace user authorization was created.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
customFieldsModelOptionalExpand 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.
customFieldsUristringOptionalThe URI for retrieving custom fields.
declinedDateTimestringOptionalThe date and time the recipient declined the document. This property is read-only.
deletedDateTimestringOptionalReserved for Docusign.
deliveredDateTimestringOptionalThe date and time that the envelope was delivered to the recipient. This property is read-only.
descriptionstringOptionalA sender-defined description of the line item.
disableResponsiveDocumentstringOptionalWhen **true,** responsive documents are disabled for the envelope.
documentBase64stringOptionalThe 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.
documentsarrayOptionalA complex element that contains details about the documents associated with the envelope.
documents[]ModelEach itemExpand Creates an envelope — request body — body documents item
documentsCombinedUristringOptionalThe URI for retrieving all of the documents associated with the envelope as a single PDF file.
documentsUristringOptionalThe URI for retrieving all of the documents associated with the envelope as separate files.
emailBlurbstringOptionalThis 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.
emailSettingsModelOptionalExpand Adds email setting overrides to an envelope — response body
A complex type that contains email settings.
emailSubjectstringOptionalThe 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.
enableWetSignstringOptionalWhen **true,** the signer is allowed to print the document and sign it on paper.
enforceSignerVisibilitystringOptionalWhen **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#
envelopeAttachmentsarrayOptionalAn array of attachment objects that provide information about the attachments that are associated with the envelope.
envelopeAttachments[]ModelEach itemExpand Updates an envelope attachment in a draft or in-process envelope — request body — body
envelopeCustomMetadataModelOptionalExpand Gets the status of a single envelope — response body — envelope Custom Metadata
envelopeDocumentsarrayOptionalAn array containing information about the documents that are included in the envelope.
envelopeDocuments[]ModelEach itemExpand Updates a template document — response body
envelopeIdstringOptionalThe 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`.

envelopeIdStampingstringOptionalWhen **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.
envelopeLocationstringOptionalReserved for Docusign.
envelopeMetadataModelOptionalExpand 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.
envelopeUristringOptionalThe URI for retrieving the envelope or envelopes.
expireAfterstringOptionalNot 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.
expireDateTimestringOptionalNot 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.
expireEnabledstringOptionalNot 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.
externalEnvelopeIdstringOptionalMay contain an external identifier for the envelope.
favoritedByMestringOptional
folderIdstringOptionalThe ID of the folder.
folderIdsarrayOptional
folderIds[]stringEach item
folderNamestringOptional
foldersarrayOptionalA list of folder objects.
folders[]ModelEach itemExpand Creates an envelope — request body — body folders item
hasCommentsstringOptionalWhen **true,** indicates that users have added comments to the envelope.
hasFormDataChangedstringOptionalWhen **true,** indicates that the data collected through form fields on a document has changed.
hasWavFilestringOptionalWhen **true,** indicates that a .wav file used for voice authentication is included in the envelope.
holderstringOptionalReserved for Docusign.
initialSentDateTimestringOptionalThe date and time the envelope was initially sent.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
isAceGenTemplatestringOptional
isDocGenTemplatestringOptional
isDynamicEnvelopestringOptionalWhen **true,** indicates that the envelope is a dynamic envelope.
isSignatureProviderEnvelopestringOptionalWhen **true,** indicates that the envelope is a signature-provided envelope.
isTicketRelatedEnvelopestringOptional
lastModifiedstringOptionalThe UTC date and time that the comment was last updated.

**Note:** This can only be done by the creator.
lastModifiedByModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
lastUsedstringOptional
locationstringOptionalReserved for Docusign.
lockInformationModelOptionalExpand Locks an envelope — response body
Provides lock information about an envelope that a user has locked.
messageLockstringOptionalWhen **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.
namestringOptional
newPasswordstringOptionalThe user's new password.
notificationModelOptionalExpand Gets envelope notification information — response body
notificationUristringOptionalThe URI for retrieving notifications.
ownerModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the template.
pageCountstringOptionalAn integer value specifying the number of document pages in the template.
passwordstringOptionalThe 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.
passwordProtectedstringOptional
powerFormModelOptionalExpand Creates a new Power Form — request body — body
Information about any PowerForms that are included in the envelope.
powerFormsarrayOptionalAn array of PowerForm objects.
powerForms[]ModelEach itemExpand Creates a new Power Form — request body — body
purgeCompletedDatestringOptionalThe date that a purge was completed.
purgeRequestDatestringOptionalThe date that a purge was requested.
purgeStatestringOptionalShows 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)

recipientsModelOptionalExpand Deletes recipients from an envelope — request body — body
An array of recipient objects that provides details about the recipients of the envelope.
recipientsLockstringOptionalWhen **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope.
recipientsUristringOptionalContains a URI for an endpoint that you can use to retrieve the recipients.
senderModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the sender of the envelope.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
sharedstringOptionalWhen **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.
signerCanSignOnMobilestringOptionalWhen **true,** recipients can sign on a mobile device.

**Note:** Only Admin users can change this setting.
signingLocationstringOptionalSpecifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.
statusstringOptionalIndicates 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.
statusChangedDateTimestringOptionalThe data and time that the status changed.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.
templatesUristringOptionalThe URI for retrieving the templates.
transactionIdstringOptionalUsed 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.
uSigStatestringOptional
uristringOptionalA URI containing the user ID.
useDisclosurestringOptionalWhen **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.
voidedDateTimestringOptionalThe date and time the envelope or template was voided.
voidedReasonstringOptionalThe reason the envelope or template was voided.

**Note:** The string is truncated to the first 200 characters.
workflowModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
bulkEnvelopeStatusModelOptionalExpand Creates an envelope — response body — bulk Envelope Status
An object that describes the status of the bulk send envelopes.
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
listCustomFieldUpdateResultsarrayOptional
listCustomFieldUpdateResults[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
lockInformationModelOptionalExpand Locks an envelope — response body
Provides lock information about an envelope that a user has locked.
purgeStatestringOptionalShows 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)

recipientUpdateResultsarrayOptionalAn array of `recipientUpdateResults` objects that contain details about the recipients.
recipientUpdateResults[]ModelEach itemExpand Updates an existing template — response body — recipient Update Results item
tabUpdateResultsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body
textCustomFieldUpdateResultsarrayOptional
textCustomFieldUpdateResults[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe recipient details that are returned after you update the recipient.
combinedstringOptionalWhen 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.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
recipientIdstringOptionalUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
recipientIdGuidstringOptionalThe 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.
tabsModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootA list of `documentVisibility` objects that specify whether documents are visible to recipients.
documentVisibilityarrayOptionalAn array of `documentVisibility` objects that specifies which documents are visible to which recipients.
documentVisibility[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootThis object configures a recipient's read/write access to a document.
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
recipientIdstringOptionalThe ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object.
rightsstringOptionalIndicates whether the document is editable:

- `editable`
- `read_only`
visiblestringOptionalWhen **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

FieldTypePresenceDescription and constraints
$objectRootA list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients.
documentVisibilityarrayOptionalAn array of `documentVisibility` objects that specifies which documents are visible to which recipients.
documentVisibility[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAn 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).
listCustomFieldsarrayOptionalAn array of list custom fields.
listCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
textCustomFieldsarrayOptionalAn array of text custom fields.
textCustomFields[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe request object containing the new information for the contacts.
contactListarrayOptionalA list of contacts.
contactList[]ModelEach itemExpand Deletes a contact — response body — contacts item

Referenced models: Deletes a contact — response body — contacts item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.