DocuSign: Esignature schemas (part 18)
42 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Deletes tabs from a template — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approveTabs | array | Optional | A list of [Approve tabs][approve]. An Approve tab enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. The value of an approve tab can't be set. [approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
approveTabs[] | Model | Each item | Expand Returns tabs on a template — response body — approve Tabs item |
checkboxTabs | array | Optional | A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
checkboxTabs[] | Model | Each item | Expand Returns tabs on a template — response body — checkbox Tabs item |
commentThreadTabs | array | Optional | An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. |
commentThreadTabs[] | Model | Each item | Expand Returns tabs on a template — response body — comment Thread Tabs item |
commissionCountyTabs | array | Optional | A list of [Commission County tabs][cc]. A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionCountyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission County Tabs item |
commissionExpirationTabs | array | Optional | A list of [Commission Expiration tabs][tabref]. A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionExpirationTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Expiration Tabs item |
commissionNumberTabs | array | Optional | A list of [Commission Number tabs][tabref]. A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Number Tabs item |
commissionStateTabs | array | Optional | A list of [Commission State tabs][cc]. A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionStateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission State Tabs item |
companyTabs | array | Optional | A list of [Company tabs][company]. A Company tab displays a field for the name of the recipient's company. This value can't be set. [company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company |
companyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — company Tabs item |
dateSignedTabs | array | Optional | A list of [Date Signed tabs][dateSigned]. A Date Signed tab displays the date that the recipient signed the document. This value can't be set. [dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateSignedTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Signed Tabs item |
dateTabs | array | Optional | A list of [Date tabs][date]. A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. [date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Tabs item |
declineTabs | array | Optional | A list of [Decline tabs][decline]. A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. [decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
declineTabs[] | Model | Each item | Expand Returns tabs on a template — response body — decline Tabs item |
drawTabs | array | Optional | A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. |
drawTabs[] | Model | Each item | Expand Returns tabs on a template — response body — draw Tabs item |
emailAddressTabs | array | Optional | A list of [Email Address tabs][emailAddress]. An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. [emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailAddressTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Address Tabs item |
emailTabs | array | Optional | A list of [Email tabs][email]. An Email tab enables the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. [email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Tabs item |
envelopeIdTabs | array | Optional | A list of [Envelope ID tabs][envelopeId]. An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. [envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid |
envelopeIdTabs[] | Model | Each item | Expand Returns tabs on a template — response body — envelope Id Tabs item |
firstNameTabs | array | Optional | A list of [First Name tabs][firstName]. A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. [firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname |
firstNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — first Name Tabs item |
formulaTabs | array | Optional | A list of [Formula tabs][formulaTab]. The value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields]. If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide]. [calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html [paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html [formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
formulaTabs[] | Model | Each item | Expand Returns tabs on a template — response body — formula Tabs item |
fullNameTabs | array | Optional | A list of [Full Name tabs][fullName]. A Full Name tab displays the recipient's full name. This value can't be set. [fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
fullNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — full Name Tabs item |
initialHereTabs | array | Optional | A list of [Initial Here tabs][initialHere]. This type of tab enables the recipient to initial the document. May be optional. This value can't be set. [initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
initialHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — initial Here Tabs item |
lastNameTabs | array | Optional | A list of [Last Name tabs][lastName]. A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. [lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
lastNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — last Name Tabs item |
listTabs | array | Optional | An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
listTabs[] | Model | Each item | Expand Returns tabs on a template — response body — list Tabs item |
notarizeTabs | array | Optional | A list of [Notarize tabs][notarize]. A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. [notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
notarizeTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notarize Tabs item |
notarySealTabs | array | Optional | A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. [notary]: /docs/notary-api/ |
notarySealTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notary Seal Tabs item |
noteTabs | array | Optional | A list of [Note tabs][note]. A Note tab displays additional information to the recipient in the form of a note. This value can be set. [note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
noteTabs[] | Model | Each item | Expand Returns tabs on a template — response body — note Tabs item |
numberTabs | array | Optional | A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). [number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
numberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — number Tabs item |
numericalTabs | array | Optional | A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). |
numericalTabs[] | Model | Each item | Expand Returns tabs on a template — response body — numerical Tabs item |
phoneNumberTabs | array | Optional | A list of [Phone Number tabs][cc]. A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
phoneNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — phone Number Tabs item |
polyLineOverlayTabs | array | Optional | This type of tab enables the recipient to strike through document text. This value can't be set. |
polyLineOverlayTabs[] | Model | Each item | Expand Returns tabs on a template — response body — poly Line Overlay Tabs item |
prefillTabs | Model | Optional | Expand Returns tabs on a template — response body — prefill Tabs Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
radioGroupTabs | array | Optional | A list of [Radio Group tabs][radioGroup]. A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. [radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
radioGroupTabs[] | Model | Each item | Expand Returns tabs on a template — response body — radio Group Tabs item |
signHereTabs | array | Optional | A list of [Sign Here tabs][signHere]. This type of tab enables the recipient to sign a document. May be optional. This value can't be set. [signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — sign Here Tabs item |
signerAttachmentTabs | array | Optional | A list of [Signer Attachment tabs][signerAttachment]. This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. [signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signerAttachmentTabs[] | Model | Each item | Expand Returns tabs on a template — response body — signer Attachment Tabs item |
smartSectionTabs | array | Optional | A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. |
smartSectionTabs[] | Model | Each item | Expand Deletes tabs from a template — request body — body smart Section Tabs item |
ssnTabs | array | Optional | A list of [SSN tabs][ssn]. An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. [ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
ssnTabs[] | Model | Each item | Expand Returns tabs on a template — response body — ssn Tabs item |
tabGroups | array | Optional | An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. |
tabGroups[] | Model | Each item | Expand Returns tabs on a template — response body — tab Groups item |
textTabs | array | Optional | A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
textTabs[] | Model | Each item | Expand Returns tabs on a template — response body — text Tabs item |
titleTabs | array | Optional | A list of [Title tabs][title]. A Title tab displays the recipient's title. This value can't be set. [title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
titleTabs[] | Model | Each item | Expand Returns tabs on a template — response body — title Tabs item |
viewTabs | array | Optional | A list of [View tabs][view]. A View tab is used with an Approve tab to handle supplemental documents. This value can be set. [view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
viewTabs[] | Model | Each item | Expand Returns tabs on a template — response body — view Tabs item |
zipTabs | array | Optional | A list of [Zip tabs][zip]. A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. [zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
zipTabs[] | Model | Each item | Expand Returns tabs on a template — response body — zip Tabs item |
Referenced models: Returns tabs on a template — response body — approve Tabs item, Returns tabs on a template — response body — checkbox Tabs item, Returns tabs on a template — response body — comment Thread Tabs item, Returns tabs on a template — response body — commission County Tabs item, Returns tabs on a template — response body — commission Expiration Tabs item, Returns tabs on a template — response body — commission Number Tabs item, Returns tabs on a template — response body — commission State Tabs item, Returns tabs on a template — response body — company Tabs item, Returns tabs on a template — response body — date Tabs item, Returns tabs on a template — response body — date Signed Tabs item, Returns tabs on a template — response body — decline Tabs item, Returns tabs on a template — response body — draw Tabs item, Returns tabs on a template — response body — email Tabs item, Returns tabs on a template — response body — email Address Tabs item, Returns tabs on a template — response body — envelope Id Tabs item, Returns tabs on a template — response body — first Name Tabs item, Returns tabs on a template — response body — formula Tabs item, Returns tabs on a template — response body — full Name Tabs item, Returns tabs on a template — response body — initial Here Tabs item, Returns tabs on a template — response body — last Name Tabs item, Returns tabs on a template — response body — list Tabs item, Returns tabs on a template — response body — notarize Tabs item, Returns tabs on a template — response body — notary Seal Tabs item, Returns tabs on a template — response body — note Tabs item, Returns tabs on a template — response body — number Tabs item, Returns tabs on a template — response body — numerical Tabs item, Returns tabs on a template — response body — phone Number Tabs item, Returns tabs on a template — response body — poly Line Overlay Tabs item, Returns tabs on a template — response body — prefill Tabs, Returns tabs on a template — response body — radio Group Tabs item, Returns tabs on a template — response body — sign Here Tabs item, Returns tabs on a template — response body — signer Attachment Tabs item, Returns tabs on a template — response body — 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, Deletes tabs from a template — request body — body smart Section Tabs item
Deletes tabs from a template — request body — body smart Section Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agreementAttribute | string | Optional | |
agreementAttributeLocked | string | Optional | |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorCaseSensitive` property is editable. |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. |
anchorMatchWholeWord | string | Optional | When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorMatchWholeWord` property is editable. |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorString` property is editable. |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorUnits` property is editable. |
anchorXOffset | string | Optional | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorXOffset` property is editable. |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorYOffset` property is editable. |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `caption` property is editable. |
caseSensitive | boolean | Optional | When **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML. |
conditionalParentLabel | string | Optional | For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentLabel` property is editable. |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentValue` property is editable. |
connectedObjectDetails | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item connected Object Details |
customTabId | string | Optional | The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
customTabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `customTabId` property is editable. |
displaySettings | Model | Optional | Expand Deletes tabs from a template — request body — body smart Section Tabs item display Settings This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `documentId` property is editable. |
endAnchor | string | Optional | Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. |
endPosition | Model | Optional | Expand Deletes tabs from a template — request body — body smart Section Tabs item end Position The last index position in the result set. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
extensionData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formOrder` property is editable. |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formPageLabel` property is editable. |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fromPageNumber` property is editable. |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `height` property is editable. |
locked | string | Optional | When **true,** the signer cannot change the data of the custom tab. |
lockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `locked` property is editable. |
mergeField | Model | Optional | Expand Creates a custom tab — response body — merge Field Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | Optional | Reserved for Docusign. |
overlayType | string | Optional | The type of overlay to draw on the document. The following overlay types are supported: - `line` - `outline` |
overlayTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `overlayType` property is editable. |
pageNumber | string | Optional | Specifies the page number on which the tab is located. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `pageNumber` property is editable. |
recipientId | string | Optional | The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientIdGuid` property is editable. |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientId` property is editable. |
removeEndAnchor | boolean | Optional | When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. |
removeStartAnchor | boolean | Optional | When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. |
shared | string | Optional | When **true,** this custom tab is shared. |
sharedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `shared` property is editable. |
smartContractInformation | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item smart Contract Information Reserved for Docusign. |
source | string | Optional | Reserved for Docusign. |
startAnchor | string | Optional | Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. |
startPosition | Model | Optional | Expand Deletes tabs from a template — request body — body smart Section Tabs item end Position The starting index position of the current result set. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `status` property is editable. |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabGroupLabels` property is editable. |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabId` property is editable. |
tabLabel | string | Optional | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabOrder` property is editable. |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabType` property is editable. |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateLocked` property is editable. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateRequired` property is editable. |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `toolTip` property is editable. |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
warningDetails | Model | Optional | Expand Locks a template — response body — error Details |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `width` property is editable. |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `xPosition` property is editable. |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `yPosition` property is editable. |
Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information, Deletes tabs from a template — request body — body smart Section Tabs item end Position, Deletes tabs from a template — request body — body smart Section Tabs item display Settings
Deletes tabs from a template — request body — body smart Section Tabs item display Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | These properties define how a Smart Section displays. A Smart Section is a type of display section. |
cellStyle | string | Optional | Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types. |
collapsibleSettings | Model | Optional | Expand Returns tabs on a template — response body — smart Section Tabs item display Settings collapsible Settings This object defines the appearance and function of a collapsible section or item. |
display | string | Optional | Indicates the display type. Must be one of the following enum values: - **inline:** Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page. - **collapsible:** The HTML in the section may be expanded or collapsed. By default, the section is expanded. - **collapsed:** The HTML in the section may be expanded or collapsed. By default, the section is collapsed. - **responsive_table:** Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. - **responsive_table_single_column:** Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. The table is converted to a single column in which each column becomes a row and is stacked. - **print_only:** Prevents this portion of the HTML from displaying in the responsive signing view. |
displayLabel | string | Optional | The label to add to this display section in the signing page. |
displayOrder | integer | Optional | The position on the page where the display section appears. Format: int32 |
displayPageNumber | integer | Optional | The number of the page on which the display section appears. Format: int32 |
hideLabelWhenOpened | boolean | Optional | When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`. |
inlineOuterStyle | string | Optional | Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`. |
labelWhenOpened | string | Optional | The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. |
preLabel | string | Optional | Enables you to add descriptive text that appears before a collapsed section or continue button. |
scrollToTopWhenOpened | boolean | Optional | When **true** and the section is expanded, the position of the section-close control scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. |
tableStyle | string | Optional | Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. |
Referenced models: Returns tabs on a template — response body — smart Section Tabs item display Settings collapsible Settings
Deletes tabs from a template — request body — body smart Section Tabs item end Position
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
pageNumber | integer | Optional | Specifies the page number on which the tab is located. Format: int32 |
xPosition | number | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. Format: double |
yPosition | number | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. Format: double |
Deletes tabs from a template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. |
approveTabs | array | Optional | A list of [Approve tabs][approve]. An Approve tab enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. The value of an approve tab can't be set. [approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
approveTabs[] | Model | Each item | Expand Returns tabs on a template — response body — approve Tabs item |
checkboxTabs | array | Optional | A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
checkboxTabs[] | Model | Each item | Expand Returns tabs on a template — response body — checkbox Tabs item |
commentThreadTabs | array | Optional | An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. |
commentThreadTabs[] | Model | Each item | Expand Returns tabs on a template — response body — comment Thread Tabs item |
commissionCountyTabs | array | Optional | A list of [Commission County tabs][cc]. A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionCountyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission County Tabs item |
commissionExpirationTabs | array | Optional | A list of [Commission Expiration tabs][tabref]. A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionExpirationTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Expiration Tabs item |
commissionNumberTabs | array | Optional | A list of [Commission Number tabs][tabref]. A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Number Tabs item |
commissionStateTabs | array | Optional | A list of [Commission State tabs][cc]. A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionStateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission State Tabs item |
companyTabs | array | Optional | A list of [Company tabs][company]. A Company tab displays a field for the name of the recipient's company. This value can't be set. [company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company |
companyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — company Tabs item |
dateSignedTabs | array | Optional | A list of [Date Signed tabs][dateSigned]. A Date Signed tab displays the date that the recipient signed the document. This value can't be set. [dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateSignedTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Signed Tabs item |
dateTabs | array | Optional | A list of [Date tabs][date]. A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. [date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Tabs item |
declineTabs | array | Optional | A list of [Decline tabs][decline]. A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. [decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
declineTabs[] | Model | Each item | Expand Returns tabs on a template — response body — decline Tabs item |
drawTabs | array | Optional | A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. |
drawTabs[] | Model | Each item | Expand Returns tabs on a template — response body — draw Tabs item |
emailAddressTabs | array | Optional | A list of [Email Address tabs][emailAddress]. An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. [emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailAddressTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Address Tabs item |
emailTabs | array | Optional | A list of [Email tabs][email]. An Email tab enables the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. [email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Tabs item |
envelopeIdTabs | array | Optional | A list of [Envelope ID tabs][envelopeId]. An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. [envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid |
envelopeIdTabs[] | Model | Each item | Expand Returns tabs on a template — response body — envelope Id Tabs item |
firstNameTabs | array | Optional | A list of [First Name tabs][firstName]. A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. [firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname |
firstNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — first Name Tabs item |
formulaTabs | array | Optional | A list of [Formula tabs][formulaTab]. The value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields]. If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide]. [calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html [paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html [formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
formulaTabs[] | Model | Each item | Expand Returns tabs on a template — response body — formula Tabs item |
fullNameTabs | array | Optional | A list of [Full Name tabs][fullName]. A Full Name tab displays the recipient's full name. This value can't be set. [fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
fullNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — full Name Tabs item |
initialHereTabs | array | Optional | A list of [Initial Here tabs][initialHere]. This type of tab enables the recipient to initial the document. May be optional. This value can't be set. [initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
initialHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — initial Here Tabs item |
lastNameTabs | array | Optional | A list of [Last Name tabs][lastName]. A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. [lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
lastNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — last Name Tabs item |
listTabs | array | Optional | An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
listTabs[] | Model | Each item | Expand Returns tabs on a template — response body — list Tabs item |
notarizeTabs | array | Optional | A list of [Notarize tabs][notarize]. A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. [notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
notarizeTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notarize Tabs item |
notarySealTabs | array | Optional | A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. [notary]: /docs/notary-api/ |
notarySealTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notary Seal Tabs item |
noteTabs | array | Optional | A list of [Note tabs][note]. A Note tab displays additional information to the recipient in the form of a note. This value can be set. [note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
noteTabs[] | Model | Each item | Expand Returns tabs on a template — response body — note Tabs item |
numberTabs | array | Optional | A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). [number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
numberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — number Tabs item |
numericalTabs | array | Optional | A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). |
numericalTabs[] | Model | Each item | Expand Returns tabs on a template — response body — numerical Tabs item |
phoneNumberTabs | array | Optional | A list of [Phone Number tabs][cc]. A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
phoneNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — phone Number Tabs item |
polyLineOverlayTabs | array | Optional | This type of tab enables the recipient to strike through document text. This value can't be set. |
polyLineOverlayTabs[] | Model | Each item | Expand Returns tabs on a template — response body — poly Line Overlay Tabs item |
prefillTabs | Model | Optional | Expand Returns tabs on a template — response body — prefill Tabs Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
radioGroupTabs | array | Optional | A list of [Radio Group tabs][radioGroup]. A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. [radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
radioGroupTabs[] | Model | Each item | Expand Returns tabs on a template — response body — radio Group Tabs item |
signHereTabs | array | Optional | A list of [Sign Here tabs][signHere]. This type of tab enables the recipient to sign a document. May be optional. This value can't be set. [signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — sign Here Tabs item |
signerAttachmentTabs | array | Optional | A list of [Signer Attachment tabs][signerAttachment]. This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. [signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signerAttachmentTabs[] | Model | Each item | Expand Returns tabs on a template — response body — signer Attachment Tabs item |
smartSectionTabs | array | Optional | A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. |
smartSectionTabs[] | Model | Each item | Expand Returns tabs on a template — response body — smart Section Tabs item |
ssnTabs | array | Optional | A list of [SSN tabs][ssn]. An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. [ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
ssnTabs[] | Model | Each item | Expand Returns tabs on a template — response body — ssn Tabs item |
tabGroups | array | Optional | An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. |
tabGroups[] | Model | Each item | Expand Returns tabs on a template — response body — tab Groups item |
textTabs | array | Optional | A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
textTabs[] | Model | Each item | Expand Returns tabs on a template — response body — text Tabs item |
titleTabs | array | Optional | A list of [Title tabs][title]. A Title tab displays the recipient's title. This value can't be set. [title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
titleTabs[] | Model | Each item | Expand Returns tabs on a template — response body — title Tabs item |
viewTabs | array | Optional | A list of [View tabs][view]. A View tab is used with an Approve tab to handle supplemental documents. This value can be set. [view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
viewTabs[] | Model | Each item | Expand Returns tabs on a template — response body — view Tabs item |
zipTabs | array | Optional | A list of [Zip tabs][zip]. A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. [zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
zipTabs[] | Model | Each item | Expand Returns tabs on a template — response body — zip Tabs item |
Referenced models: Returns tabs on a template — response body — approve Tabs item, Returns tabs on a template — response body — checkbox Tabs item, Returns tabs on a template — response body — comment Thread Tabs item, Returns tabs on a template — response body — commission County Tabs item, Returns tabs on a template — response body — commission Expiration Tabs item, Returns tabs on a template — response body — commission Number Tabs item, Returns tabs on a template — response body — commission State Tabs item, Returns tabs on a template — response body — company Tabs item, Returns tabs on a template — response body — date Tabs item, Returns tabs on a template — response body — date Signed Tabs item, Returns tabs on a template — response body — decline Tabs item, Returns tabs on a template — response body — draw Tabs item, Returns tabs on a template — response body — email Tabs item, Returns tabs on a template — response body — email Address Tabs item, Returns tabs on a template — response body — envelope Id Tabs item, Returns tabs on a template — response body — first Name Tabs item, Returns tabs on a template — response body — formula Tabs item, Returns tabs on a template — response body — full Name Tabs item, Returns tabs on a template — response body — initial Here Tabs item, Returns tabs on a template — response body — last Name Tabs item, Returns tabs on a template — response body — list Tabs item, Returns tabs on a template — response body — notarize Tabs item, Returns tabs on a template — response body — notary Seal Tabs item, Returns tabs on a template — response body — note Tabs item, Returns tabs on a template — response body — number Tabs item, Returns tabs on a template — response body — numerical Tabs item, Returns tabs on a template — response body — phone Number Tabs item, Returns tabs on a template — response body — poly Line Overlay Tabs item, Returns tabs on a template — response body — prefill Tabs, Returns tabs on a template — response body — radio Group Tabs item, Returns tabs on a template — response body — sign Here Tabs item, Returns tabs on a template — response body — signer Attachment Tabs item, Returns tabs on a template — response body — smart Section Tabs item, Returns tabs on a template — response body — ssn Tabs item, Returns tabs on a template — response body — tab Groups item, Returns tabs on a template — response body — text Tabs item, Returns tabs on a template — response body — title Tabs item, Returns tabs on a template — response body — view Tabs item, Returns tabs on a template — response body — zip Tabs item
Deletes the image for a stamp — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adoptedDateTime | string | Optional | The UTC date and time when the user adopted the signature. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customField | string | Optional | |
dateStampProperties | Model | Optional | Expand Deletes the image for a stamp — response body — date Stamp Properties Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. |
disallowUserResizeStamp | string | Optional | When **true,** users may not resize the stamp. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
externalID | string | Optional | Optionally specify an external identifier for the user's signature. |
imageBase64 | string | Optional | |
imageType | string | Optional | Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image` |
initials150ImageId | string | Optional | The ID of the user's initials image. |
initialsImageUri | string | Optional | The URI for retrieving the image of the user's initials. |
isDefault | string | Optional | Boolean that specifies whether the signature is the default signature for the user. |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
nrdsId | string | Optional | The National Association of Realtors (NAR) membership ID for a user who is a realtor. |
nrdsLastName | string | Optional | The realtor's last name. |
nrdsStatus | string | Optional | The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are: - `Active` - `Inactive` - `Terminate` - `Provisional` - `Deceased` - `Suspend` - `Unknown` |
phoneticName | string | Optional | The phonetic spelling of the `signatureName`. |
signature150ImageId | string | Optional | The ID of the user's signature image. |
signatureFont | string | Optional | The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`. - `"1_DocuSign"` - `"2_DocuSign"` - `"3_DocuSign"` - `"4_DocuSign"` - `"5_DocuSign"` - `"6_DocuSign"` - `"7_DocuSign"` - `"8_DocuSign"` - `"Mistral"` - `"Rage Italic"` |
signatureGroups | array | Optional | |
signatureGroups[] | Model | Each item | Expand Deletes the image for a stamp — response body — signature Groups item |
signatureId | string | Optional | Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. |
signatureImageUri | string | Optional | An endpoint URI that you can use to retrieve the user's signature image. |
signatureInitials | string | Optional | Specifies the user's signature in initials format. |
signatureName | string | Optional | Specifies the user's signature name. |
signatureRights | string | Optional | The rights that the user has to the signature. Valid values are: - `none` - `read` - `admin` |
signatureType | string | Optional | Specifies the type of signature. |
signatureUsers | array | Optional | |
signatureUsers[] | Model | Each item | Expand Deletes the image for a stamp — response body — signature Users item |
stampFormat | string | Optional | The format of a stamp. Valid values are: - `NameHanko`: The stamp represents only the signer's name. - `NameDateHanko`: The stamp represents the signer's name and the date. |
stampImageUri | string | Optional | The URI for retrieving the image of the user's stamp. |
stampSizeMM | string | Optional | The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. |
stampType | string | Optional | The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null |
status | string | Optional | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. |
Referenced models: Deletes the image for a stamp — response body — date Stamp Properties, Locks a template — response body — error Details, Deletes the image for a stamp — response body — signature Groups item, Deletes the image for a stamp — response body — signature Users item
Deletes the image for a stamp — response body — date Stamp Properties
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. |
dateAreaHeight | string | Optional | The height of the rectangle. |
dateAreaWidth | string | Optional | The width of the rectangle. |
dateAreaX | string | Optional | The X axis position of the top-left corner. |
dateAreaY | string | Optional | The Y axis position of the top-left corner. |
Deletes the image for a stamp — response body — signature Groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
groupId | string | Optional | The ID of the group being accessed. |
groupName | string | Optional | The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. |
rights | string | Optional | Indicates whether the property is editable. Valid values are: - `editable` - `read_only` |
Deletes the image for a stamp — response body — signature Users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
isDefault | string | Optional | Boolean that specifies whether the signature is the default signature for the user. |
rights | string | Optional | Indicates whether the property is editable. Valid values are: - `editable` - `read_only` |
userId | string | Optional | The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. |
userName | string | Optional | The name of the user. |
Deletes the signature for one or more captive recipient records — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about captive (embedded) recipients. |
captiveRecipients | array | Optional | A complex type containing information about one or more captive recipients. |
captiveRecipients[] | Model | Each item | Expand Deletes the signature for one or more captive recipient records — response body — captive Recipients item |
Referenced models: Deletes the signature for one or more captive recipient records — response body — captive Recipients item
Deletes the signature for one or more captive recipient records — response body — captive Recipients item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a captive (embedded) recipient. |
clientUserId | string | Optional | Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. If the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. |
email | string | Optional | The email address associated with the captive recipient. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
userName | string | Optional | The username associated with the captive recipient. |
Referenced models: Locks a template — response body — error Details
Deprecated. Use Envelopes: list Status Changes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Results from a folder item request. |
endPosition | string | Optional | The last index position in the result set. |
folderItems | array | Optional | A list of the envelopes in the specified folder or folders. |
folderItems[] | Model | Each item | Expand Deprecated. Use Envelopes: list Status Changes — response body — folder Items item |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalRows | string | Optional | The total number of items in the result. |
Referenced models: Deprecated. Use Envelopes: list Status Changes — response body — folder Items item
Deprecated. Use Envelopes: list Status Changes — response body — folder Items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about folder item results. |
completedDateTime | string | Optional | If the item is an envelope, this is the UTC DateTime when the envelope was completed. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
envelopeId | string | Optional | If the item is an envelope, this is the ID of the envelope. |
envelopeUri | string | Optional | If the item is an envelope, this is the URI for retrieving it. |
expireDateTime | string | Optional | The date and time the envelope is set to expire. |
folderId | string | Optional | The ID of the folder. |
folderUri | string | Optional | If the item is a subfolder, this is the URI for retrieving it. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
ownerName | string | Optional | The name of the user who owns the folder. |
recipients | Model | Optional | Expand Deletes recipients from an envelope — response body An array of recipient objects that provides details about the recipients of the envelope. |
recipientsUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the recipients. |
senderCompany | string | Optional | The name of the sender's company. |
senderEmail | string | Optional | The sender's email address. |
senderName | string | Optional | The sender's name. |
senderUserId | string | Optional | The sender's id. |
sentDateTime | string | Optional | The UTC DateTime when the envelope was sent. This property is read-only. |
status | string | Optional | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. |
subject | string | Optional | The subject of the envelope. |
templateId | string | Optional | The unique identifier of the template. If this is not provided, Docusign will generate a value. |
templateUri | string | Optional | The URI for retrieving the template. |
Referenced models: Deletes recipients from an envelope — response body
Generate and convert multiple documents — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
generatedDocuments | array | Optional | |
generatedDocuments[] | Model | Each item | Expand Generate and convert multiple documents — response body — generated Documents item |
Referenced models: Generate and convert multiple documents — response body — generated Documents item
Generate and convert multiple documents — response body — generated Documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documentAsBase64 | string | Optional | |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentName | string | Optional | |
fileExtension | string | Optional |
Get Account Billing Plan — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines an account billing plan response object. |
billingAddress | Model | Optional | Expand Get Account Billing Plan — response body — billing Address The billing address for the account. |
billingAddressIsCreditCardAddress | string | Optional | When **true,** the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different. |
billingPlan | Model | Optional | Expand Get Account Billing Plan — response body — billing Plan An object that contains details about the billing plan. |
creditCardInformation | Model | Optional | Expand Get credit card information — response body A complex type that has information about the credit card used to pay for this account. |
directDebitProcessorInformation | Model | Optional | Expand Get Account Billing Plan — response body — direct Debit Processor Information Information about the bank that processes direct debits for the payment plan. |
downgradePlanInformation | Model | Optional | Expand Queues downgrade billing plan request for an account — response body |
downgradeRequestInformation | Model | Optional | Expand Get Account Billing Plan — response body — downgrade Request Information |
entityInformation | Model | Optional | Expand Get Account Billing Plan — response body — entity Information |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
paymentProcessorInformation | Model | Optional | Expand Get Account Billing Plan — response body — payment Processor Information Information about the entity that processes payments for the billing plan. |
referralInformation | Model | Optional | Expand Get Account Billing Plan — response body — referral Information A complex type that contains properties for entering referral and discount information. |
successorPlans | array | Optional | A list of billing plans that the current billing plan can be rolled into. |
successorPlans[] | Model | Each item | Expand Gets billing plan details — response body — billing Plan |
taxExemptId | string | Optional |
Referenced models: Get Account Billing Plan — response body — billing Address, Get Account Billing Plan — response body — billing Plan, Get Account Billing Plan — response body — entity Information, Gets billing plan details — response body — billing Plan, Get credit card information — response body, Get Account Billing Plan — response body — direct Debit Processor Information, Queues downgrade billing plan request for an account — response body, Get Account Billing Plan — response body — downgrade Request Information, Get Account Billing Plan — response body — payment Processor Information, Get Account Billing Plan — response body — referral Information
Get Account Billing Plan — response body — billing Address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the address associated with the account. |
address1 | string | Optional | The first line of the address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the address. Maximum length: 100 characters. |
city | string | Optional | The city associated with the address. Maximum length: 40 characters. |
country | string | Optional | The country associated with the address. Maximum length: 50 characters. |
email | string | Optional | The email address associated with the account. |
fax | string | Optional | The fax number associated with the account. |
firstName | string | Optional | The first name of the user associated with the account. Maximum Length: 50 characters. |
lastName | string | Optional | The last name of the user associated with the account. |
phone | string | Optional | The phone number associated with the account. |
postalCode | string | Optional | The postal code associated with the address. Maximum length: 20 characters. |
state | string | Optional | The state or province associated with the address. Maximum length: 40 characters. |
supportedCountries | array | Optional | An array of supported countries associated with the account. |
supportedCountries[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Address supported Countries item |
Referenced models: Get Account Billing Plan — response body — billing Address supported Countries item
Get Account Billing Plan — response body — billing Address supported Countries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
isoCode | string | Optional | |
name | string | Optional | |
provinceValidated | string | Optional | |
provinces | array | Optional | |
provinces[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Address supported Countries item provinces item |
Referenced models: Get Account Billing Plan — response body — billing Address supported Countries item provinces item
Get Account Billing Plan — response body — billing Address supported Countries item provinces item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
isoCode | string | Optional | |
name | string | Optional |
Get Account Billing Plan — response body — billing Plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an account billing plan. |
addOns | array | Optional | Reserved for Docusign. |
addOns[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan add Ons item |
appStoreReceiptExpirationDate | string | Optional | |
appStoreReceiptPurchaseDate | string | Optional | |
canCancelRenewal | string | Optional | Reserved for Docusign. |
canUpgrade | string | Optional | When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response. |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code to use for the account. |
downgradePlanInformation | Model | Optional | Expand Queues downgrade billing plan request for an account — response body |
enableSupport | string | Optional | When **true,** customer support is provided as part of the account plan. |
includedSeats | string | Optional | The number of seats (users) included in the plan. |
incrementalSeats | string | Optional | Reserved for Docusign. |
isDowngrade | string | Optional | When **true,** the account has been downgraded from a premium account type. Otherwise **false.** |
notificationType | string | Optional | |
otherDiscountPercent | string | Optional | Any other percentage discount for the plan. |
paymentCycle | string | Optional | The payment cycle associated with the plan. Valid values: - `Monthly` - `Annually` |
paymentMethod | string | Optional | The payment method used with the plan. Valid values: CreditCard, PurchaseOrder, Premium, or Freemium. |
perSeatPrice | string | Optional | The per-seat price associated with the plan. Example: `"456.0000"` |
planClassification | string | Optional | Identifies the type of plan. Examples include: - `business` - `corporate` - `enterprise` - `free` |
planFeatureSets | array | Optional | A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). |
planFeatureSets[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan plan Feature Sets item |
planId | string | Optional | Docusign's ID for the account plan. |
planName | string | Optional | The name of the Billing Plan. |
planStartDate | string | Optional | The date that the Account started using the current plan. |
productId | string | Optional | The Product ID from the AppStore. |
renewalDate | string | Optional | |
renewalStatus | string | Optional | The renewal status for the account. Valid 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`. **Note:** For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response. |
seatDiscounts | array | Optional | A complex type that contains any seat discount information. Valid values: - `BeginSeatCount` - `EndSeatCount` - `SeatDiscountPercent` |
seatDiscounts[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan seat Discounts item |
subscriptionStartDate | string | Optional | |
supportIncidentFee | string | Optional | The support incident fee charged for each support incident. Example: `"$0.00"` |
supportPlanFee | string | Optional | The support plan fee charged for this plan. Example: `"$0.00"` |
taxExemptId | string | Optional |
Referenced models: Get Account Billing Plan — response body — billing Plan add Ons item, Queues downgrade billing plan request for an account — response body, Get Account Billing Plan — response body — billing Plan plan Feature Sets item, Get Account Billing Plan — response body — billing Plan seat Discounts item
Get Account Billing Plan — response body — billing Plan add Ons item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about add ons. |
active | string | Optional | Reserved for Docusign. |
addOnId | string | Optional | Reserved for Docusign. |
id | string | Optional | A unique ID for the Salesforce object. |
name | string | Optional | Reserved for Docusign. |
Get Account Billing Plan — response body — billing Plan plan Feature Sets item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for Docusign internal use only. |
currencyFeatureSetPrices | array | Optional | Reserved for Docusign. |
currencyFeatureSetPrices[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item |
envelopeFee | string | Optional | Reserved for Docusign. |
featureSetId | string | Optional | Reserved for Docusign. |
fixedFee | string | Optional | Reserved for Docusign. |
is21CFRPart11 | string | Optional | Reserved for Docusign. |
isActive | string | Optional | Reserved for Docusign. |
isEnabled | string | Optional | When **true,** the feature set is actively enabled as part of the plan. |
name | string | Optional | Reserved for Docusign. |
seatFee | string | Optional | Reserved for Docusign. |
Referenced models: Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the price and currency associated with the feature set. Reserved for internal Docusign use only. |
currencyCode | string | Optional | Specifies the alternate ISO currency code for the account. |
currencySymbol | string | Optional | Reserved for Docusign. |
envelopeFee | string | Optional | Reserved for Docusign. |
fixedFee | string | Optional | Reserved for Docusign. |
seatFee | string | Optional | Reserved for Docusign. |
Get Account Billing Plan — response body — billing Plan seat Discounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a seat discount. |
beginSeatCount | string | Optional | Reserved for Docusign. |
discountPercent | string | Optional | The percent of the discount. Example: `"0.00"` |
endSeatCount | string | Optional | Reserved for Docusign. |
Get Account Billing Plan — response body — direct Debit Processor Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about a bank that processes a customer's direct debit payments. |
bankBranchCode | string | Optional | The branch code of the bank used for direct debit. Maximum Length: 10 characters. |
bankCheckDigit | string | Optional | The check digit or digits in the international bank account number. These digits are used to confirm the validity of the account. Maximum Length: 4 characters. |
bankCode | string | Optional | The code or number that identifies the bank. This is also known as the sort code. Example: `200000` Maximum Length: 18 characters. |
bankName | string | Optional | The name of the direct debit bank. Maximum Length: 80 characters. |
bankTransferAccountName | string | Optional | The name on the direct debit bank account. This field is required for POST and PUT requests. Maximum Length: 60 characters. |
bankTransferAccountNumber | string | Optional | The customer's bank account number. This value will be obfuscated. This field is required for POST and PUT requests. Maximum Length: 30 characters. |
bankTransferType | string | Optional | Specifies the type of direct debit transfer. The value of this field is dependent on the user's country. This field is required for POST and PUT requests. Possible values are: - `DirectDebitUK` - `DirectEntryAU` - `SEPA` |
country | string | Optional | The user's country. The system populates this value automatically. |
email | string | Optional | The email address of the user who is associated with the payment method. This field is required for POST and PUT requests. Maximum Length: 80 characters. |
firstName | string | Optional | The user's first name. This field is required for POST and PUT requests. Maximum Length: 30 characters. |
iBAN | string | Optional | The International Bank Account Number (IBAN). Example: `DE89370400440532013000` For more information, see [PeopleSoft's guide to Setting Up Banks](https://docs.oracle.com/cd/E16365_01/fscm91pbr0/eng/psbooks/fsbk/chapter.htm?File=fsbk/htm/fsbk03.htm). **Note:** This number will be obfuscated. |
lastName | string | Optional | The user's last name. This field is required for POST and PUT requests. Maximum Length: 70 characters. |
Get Account Billing Plan — response body — downgrade Request Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
downgradeRequestCreation | string | Optional | |
downgradeRequestProductId | string | Optional | |
downgradeRequestStatus | string | Optional |
Get Account Billing Plan — response body — entity Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billingProfile | string | Optional | The type of billing method on the account. Valid values are: - `direct` - `web` |
entityName | string | Optional | |
externalEntityId | string | Optional | |
isExternallyBilled | string | Optional |
Get Account Billing Plan — response body — payment Processor Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Get credit card information — response body — address The mailing address associated with the payment processor. |
billingAgreementId | string | Optional | The ID of the billing agreement. |
email | string | Optional | The email address associated with the payment processor. |
Referenced models: Get credit card information — response body — address
Get Account Billing Plan — response body — referral Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry **Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only. |
advertisementId | string | Optional | A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. **Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only. |
enableSupport | string | Optional | When **true,** customer support is provided as part of the account plan. |
externalOrgId | string | Optional | An optional external ID for the referral. |
groupMemberId | string | Optional | |
idType | string | Optional | |
includedSeats | string | Optional | The number of seats (users) included in the plan. |
industry | string | Optional | The name of the industry associated with the referral. Example: `Accounting` |
planStartMonth | string | Optional | |
promoCode | string | Optional | |
publisherId | string | Optional | |
referralCode | string | Optional | |
referrerName | string | Optional | The name of the referrer. |
saleDiscountAmount | string | Optional | Reserved for Docusign. |
saleDiscountFixedAmount | string | Optional | Reserved for Docusign. |
saleDiscountPercent | string | Optional | Reserved for Docusign. |
saleDiscountPeriods | string | Optional | Reserved for Docusign. |
saleDiscountSeatPriceOverride | string | Optional | Reserved for Docusign. |
shopperId | string | Optional |
Get Connect configuration information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains the results of a ConnectConfigurations::GET method. |
configurations | array | Optional | An array of Docusign Connect configurations. |
configurations[] | Model | Each item | Expand Creates a Connect configuration — response body |
totalRecords | string | Optional | The number of results. |
Referenced models: Creates a Connect configuration — response body
Get Workspace — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Docusign workspace is a collaboration area for sharing files and data. |
billableAccountId | string | Optional | The ID of the account to bill. |
callerInformation | Model | Optional | Expand Get Workspace — response body — caller Information |
created | string | Optional | The UTC DateTime when the workspace user authorization was created. |
createdByInformation | Model | Optional | Expand Get Workspace — response body — caller Information Details about the user who created the workspace. |
lastModified | string | Optional | Utc date and time the comment was last updated (can only be done by creator.) |
lastModifiedByInformation | Model | Optional | Expand Get Workspace — response body — caller Information Details about the user who last modified the workspace. |
settings | Model | Optional | Expand Get Workspace — response body — settings Information about the settings for the workspace. |
status | string | Optional | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. |
workspaceBaseUrl | string | Optional | The relative URL for accessing the workspace. |
workspaceDescription | string | Optional | Text describing the purpose of the workspace. |
workspaceId | string | Optional | The ID of the workspace, always populated. |
workspaceName | string | Optional | The name of the workspace. |
workspaceUri | string | Optional | The relative URI for accessing the workspace. |
Referenced models: Get Workspace — response body — settings, Get Workspace — response body — caller Information
Get Workspace — response body — caller Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents the workspace user. This property is only returned in response to user specific GET call. |
accountId | string | Optional | The account ID associated with the workspace user. |
accountName | string | Optional | The name of the account that the workspace user belongs to. |
activeSince | string | Optional | The UTC DateTime when the user joined the workspace. |
created | string | Optional | The UTC DateTime when the workspace user was created. |
createdById | string | Optional | The ID of the user who created this workspace user. |
email | string | Optional | The workspace user's email address. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
invitationEmailBlurb | string | Optional | The text of the workspace invitation email message sent to the user. |
invitationEmailSubject | string | Optional | The subject line of the workspace invitation email message sent to the user. |
lastModified | string | Optional | The UTC DateTime that the workspace user was last modified. |
lastModifiedById | string | Optional | The ID of the user who last modified the workspace user. |
status | string | Optional | Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled |
type | string | Optional | Type of the user. Valid values: type_owner, type_participant. |
userId | string | Optional | The ID of the workspace user. |
userName | string | Optional | The name of workspace user. |
workspaceId | string | Optional | The ID of the workspace. |
workspaceUserBaseUrl | string | Optional | The URL for accessing the workspace user. |
workspaceUserId | string | Optional | The ID of the workspace user. |
workspaceUserUri | string | Optional | The URI for accessing the workspace user. |
Referenced models: Locks a template — response body — error Details
Get Workspace — response body — settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object provides information about the settings for the workspace. |
commentsAllowed | string | Optional | When **true,** commenting on the documents in the workspace is allowed. |
Get a List of Billing Invoices — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a billing invoice response object. |
billingInvoices | array | Optional | Reserved for Docusign. |
billingInvoices[] | Model | Each item | Expand Retrieves a billing invoice — response body |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
Referenced models: Retrieves a billing invoice — response body
Get a list of past due invoices — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountBalance | string | Optional | |
billingInvoices | array | Optional | Reserved for Docusign. |
billingInvoices[] | Model | Each item | Expand Retrieves a billing invoice — response body |
currencyCode | string | Optional | The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. |
pastDueBalance | string | Optional | |
paymentAllowed | string | Optional |
Referenced models: Retrieves a billing invoice — response body
Get credit card information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a credit card that is associated with an account. |
address | Model | Optional | Expand Get credit card information — response body — address A complex element containing the credit card billing address information. |
cardLastDigits | string | Optional | |
cardNumber | string | Optional | The credit card number. |
cardType | string | Optional | The type of credit card. Valid values are: - `visa` - `mastercard` - `amex` |
cvNumber | string | Optional | The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs). |
expirationMonth | string | Optional | The month that the credit card expires, expressed as a number from 1 to 12. |
expirationYear | string | Optional | The year in which the credit card expires, in 4-digit format. |
nameOnCard | string | Optional | The exact name as it appears on the credit card. |
tokenizedCard | string | Optional |
Referenced models: Get credit card information — response body — address
Get credit card information — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains address information. |
address1 | string | Optional | The first line of the user's address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the user's address. Maximum length: 100 characters. |
city | string | Optional | The user's city. Maximum length: 40 characters. |
country | string | Optional | The user's country. Maximum length: 50 characters. |
fax | string | Optional | A fax number associated with the address, if one is available. |
phone | string | Optional | A phone number associated with the address. |
postalCode | string | Optional | The user's postal code. Maximum length: 20 characters. |
stateOrProvince | string | Optional | The user's state or province. Maximum length: 40 characters. |
zipPlus4 | string | Optional |
Get the Cloud Storage Provider configuration for the specified user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
storageProviders | array | Optional | An Array containing the storage providers associated with the user. |
storageProviders[] | Model | Each item | Expand Get the Cloud Storage Provider configuration for the specified user — response body — storage Providers item |
Referenced models: Get the Cloud Storage Provider configuration for the specified user — response body — storage Providers item
Get the Cloud Storage Provider configuration for the specified user — response body — storage Providers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about a specific cloud storage provider. |
authenticationUrl | string | Optional | The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
redirectUrl | string | Optional | The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains. |
service | string | Optional | The service name for the cloud storage provider. |
serviceId | string | Optional | The Docusign-generated ID for the cloud storage provider. |
Referenced models: Locks a template — response body — error Details
Get watermark preview — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
displayAngle | string | Optional | The display angle of the watermark. Valid values: * 0 (horizontal) * 45 (diagonal) * 90 (vertical) |
enabled | string | Optional | When **true,** the watermark will be applied to documents that are still in progress. When **false,** the watermark will not be applied. |
font | string | Optional | The watermark's font. Valid values: - `courier` - `helvetica` - `timesnewroman` |
fontColor | string | Optional | The watermark's font color. Valid values: * `black` * `blue` * `red` * `gray` * `yellow` |
fontSize | string | Optional | The watermark's font size. Valid values: * `30` * `40` * `50` * `60` * `70` * `80` * `90` |
id | string | Optional | The ID of the watermark. |
imageBase64 | string | Optional | The Base64 representation of the watermark image. This property is read-only. |
transparency | string | Optional | The transparency percentage of the watermark image. Valid values: * `5` * `10` * `15` * `20` * `25` * `30` * `35` * `40` * `45` |
watermarkText | string | Optional | The text for the watermark. |
Gets Power Form senders — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object includes information about the users who have sent PowerForms. |
endPosition | JSON | Optional | |
endPosition (anyOf 1) | integer | Alternative | The last index position in the result set. Format: int32 |
endPosition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
powerFormSenders | array | Optional | An array of `userInfo` objects containing information about users who have sent PowerForms. |
powerFormSenders[] | Model | Each item | Expand Gets a specific template associated with a specified account — response body — owner |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | JSON | Optional | |
resultSetSize (anyOf 1) | integer | Alternative | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. Format: int32 |
resultSetSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startPosition | JSON | Optional | |
startPosition (anyOf 1) | integer | Alternative | The starting index position of the current result set. Format: int32 |
startPosition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalSetSize | JSON | Optional | |
totalSetSize (anyOf 1) | integer | Alternative | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. Format: int32 |
totalSetSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Gets a specific template associated with a specified account — response body — owner
Gets a BCC email archive configuration and its history — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bccEmailArchiveHistory | array | Optional | A list of changes to the BCC email archive configuration. |
bccEmailArchiveHistory[] | Model | Each item | Expand Gets a BCC email archive configuration and its history — response body — bcc Email Archive History item |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Gets a BCC email archive configuration and its history — response body — bcc Email Archive History item