DocuSign: Esignature schemas (part 6)
9 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Add envelope archive metadata — request body — body documents item tabs number Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Number tabs validate that the entered value is a number. They do not support advanced validation or display options. See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) to learn more about this tab type. |
agreementAttribute | string | Optional | When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract |
agreementAttributeLocked | string | Optional | When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. |
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, `Docu Sign` 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 `Docu Sign` will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
bold | string | Optional | When **true,** the information in the tab is bold. |
boldMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
concealValueOnDocument | string | Optional | When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
connectedObjectDetails | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields 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 |
disableAutoSize | string | Optional | When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. |
disableAutoSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
extensionData | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data |
font | string | Optional | The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana |
fontColor | string | Optional | The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White |
fontColorMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontSize | string | Optional | The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 |
fontSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
formula | string | Optional | Contains the formula for calculating the value of this tab. Use a tab's `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters |
formulaMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
isPaymentAmount | string | Optional | When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. |
isPaymentAmountMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
italic | string | Optional | When **true,** the information in the tab is italic. |
italicMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
localePolicy | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy |
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 |
maxLength | string | Optional | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
mergeField | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field |
mergeFieldXml | string | Optional | Reserved for Docusign. |
name | string | Optional | The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
originalValue | string | Optional | The initial value of the tab. |
originalValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
pageNumber | string | Optional | The page number on which the tab is located. For supplemental documents, this value must be `1`. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
requireAll | string | Optional | When **true** and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
requireInitialOnSharedChange | string | Optional | Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
required | string | Optional | When **true,** the signer is required to fill out this tab. |
requiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
senderRequired | string | Optional | When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. |
senderRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shareToRecipients | string | Optional | Reserved for Docusign. |
shareToRecipientsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shared | string | Optional | When **true,** this custom tab is shared. |
sharedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
smartContractInformation | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information |
source | string | Optional | Reserved for Docusign. |
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 |
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 |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
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 |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
underline | string | Optional | When **true,** the information in the tab is underlined. |
underlineMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
validationMessage | string | Optional | The message displayed if the custom tab fails input validation (either custom of embedded). |
validationMessageMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
validationPattern | string | Optional | A regular expression used to validate input for the tab. |
validationPatternMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
value | string | Optional | Specifies the value of the tab. |
valueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
warningDetails | Model | Optional | Expand Add envelope archive metadata — 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 |
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. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
Add envelope archive metadata — request body — body documents item tabs numerical Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) to learn more about this tab type. |
agreementAttribute | string | Optional | N/A - do not use |
agreementAttributeLocked | string | Optional | N/A - do not use |
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, `Docu Sign` 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 `Docu Sign` will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
bold | string | Optional | When **true,** the information in the tab is bold. |
boldMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
concealValueOnDocument | string | Optional | When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
connectedObjectDetails | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields 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 |
disableAutoSize | string | Optional | When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. |
disableAutoSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This ID must refer to an existing document. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
extensionData | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data |
font | string | Optional | The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana |
fontColor | string | Optional | The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White |
fontColorMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontSize | string | Optional | The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 |
fontSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
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 |
italic | string | Optional | When **true,** the information in the tab is italic. |
italicMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
localePolicy | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy |
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 |
maxLength | string | Optional | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
maxNumericalValue | string | Optional | The maximum value that the numerical tab can take on. The largest value allowed, and the default if not specified, is `999999999.99` |
mergeField | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field |
mergeFieldXml | string | Optional | Reserved for Docusign. |
minNumericalValue | string | Optional | The minimum value that the numerical tab can take on. The smallest value allowed, and the default if not specified, is `-999999999.99` |
name | string | Optional | The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
numericalValue | string | Optional | The raw numerical value of the tab. For example, if the locale policy is `en-US` and the `numericalValue` is `-1234.56`, the `value` property will contain the string `"($ 1,234.56)"`. |
originalNumericalValue | string | Optional | The original value of the tab. |
originalValue | string | Optional | The initial value of the tab. |
originalValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
requireAll | string | Optional | When **true** and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
requireInitialOnSharedChange | string | Optional | Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
required | string | Optional | When **true,** the signer is required to fill out this tab. |
requiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
senderRequired | string | Optional | When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. |
senderRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shareToRecipients | string | Optional | Reserved for Docusign. |
shareToRecipientsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shared | string | Optional | When **true,** this tab is shared. |
sharedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
smartContractInformation | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information |
source | string | Optional | |
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. |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
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 |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
underline | string | Optional | When **true,** the information in the tab is underlined. |
underlineMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
validationType | string | Optional | Specifies how numerical data is validated. Valid values: - `number` - `currency` |
value | string | Optional | The `numericalValue` of the tab displayed according to its locale policy. For example, if the locale policy is `en-US` and the `numericalValue` is `-1234.56`, this property will contain the string `"($ 1,234.56)"`. |
valueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
warningDetails | Model | Optional | Expand Add envelope archive metadata — 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 |
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 |
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 |
Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
Add envelope archive metadata — request body — body documents item tabs phone Number Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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]. [notary]: /docs/notary-api/ |
agreementAttribute | string | Optional | N/A - do not use |
agreementAttributeLocked | string | Optional | N/A - do not use |
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, `Docu Sign` 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 `Docu Sign` will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
bold | string | Optional | When **true,** the information in the tab is bold. |
boldMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
concealValueOnDocument | string | Optional | When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
connectedObjectDetails | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields 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 |
disableAutoSize | string | Optional | When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. |
disableAutoSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
extensionData | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data |
font | string | Optional | The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana |
fontColor | string | Optional | The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White |
fontColorMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontSize | string | Optional | The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 |
fontSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
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 |
italic | string | Optional | When **true,** the information in the tab is italic. |
italicMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
localePolicy | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy |
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 |
maxLength | string | Optional | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
mergeField | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field |
mergeFieldXml | string | Optional | Reserved for Docusign. |
name | string | Optional | |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
originalValue | string | Optional | The initial value of the tab. |
originalValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
required | string | Optional | When **true,** the signer is required to fill out this tab. |
requiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
smartContractInformation | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information |
source | string | Optional | Reserved for Docusign. |
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. |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
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 |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
underline | string | Optional | When **true,** the information in the tab is underlined. |
underlineMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
value | string | Optional | Specifies the value of the tab. |
valueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
warningDetails | Model | Optional | Expand Add envelope archive metadata — 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 |
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 |
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 |
Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates. |
agreementAttribute | string | Optional | N/A - do not use |
agreementAttributeLocked | string | Optional | N/A - do not use |
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, `Docu Sign` 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 `Docu Sign` will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
connectedObjectDetails | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields 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 |
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 |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
extensionData | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs 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 |
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 |
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 |
graphicsContext | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item graphics Context |
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 |
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 |
mergeField | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field |
mergeFieldXml | string | Optional | Reserved for Docusign. |
overlayType | string | Optional | The type of overlay to use. The API currently supports only the `outline` overlay type. |
overlayTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
polyLines | array | Optional | An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines. |
polyLines[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item poly Lines item |
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 |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shared | string | Optional | When **true,** indicates that the tab is shared. |
sharedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
smartContractInformation | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information |
source | string | Optional | Reserved for Docusign. |
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 |
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 |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
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 |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
warningDetails | Model | Optional | Expand Add envelope archive metadata — 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 |
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 |
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 |
Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item graphics Context, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item poly Lines item, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item graphics Context
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fillColor | string | Optional | The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). |
lineColor | string | Optional | The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). |
lineWeight | string | Optional | The line weight or thickness to use for the overlay. |
Add envelope archive metadata — request body — body documents item tabs poly Line Overlay Tabs item poly Lines item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
x1 | string | Optional | |
x2 | string | Optional | |
y1 | string | Optional | |
y2 | string | Optional |
Add envelope archive metadata — request body — body documents item tabs prefill Tabs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [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/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
checkboxTabs | array | Optional | A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. |
checkboxTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs checkbox Tabs item |
dateTabs | array | Optional | A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). 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. |
dateTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs date Tabs item |
emailTabs | array | Optional | A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). 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. |
emailTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs email 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). |
numberTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs number Tabs item |
radioGroupTabs | array | Optional | A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). 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. |
radioGroupTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs radio Group Tabs item |
senderCompanyTabs | array | Optional | |
senderCompanyTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs prefill Tabs sender Name Tabs item |
senderNameTabs | array | Optional | |
senderNameTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs prefill Tabs sender Name Tabs item |
ssnTabs | array | Optional | A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). 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. |
ssnTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs 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 Add envelope archive metadata — request body — body documents item tabs 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](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). |
textTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs text Tabs item |
zipTabs | array | Optional | A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). 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. |
zipTabs[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs zip Tabs item |
Referenced models: Add envelope archive metadata — request body — body documents item tabs checkbox Tabs item, Add envelope archive metadata — request body — body documents item tabs date Tabs item, Add envelope archive metadata — request body — body documents item tabs email Tabs item, Add envelope archive metadata — request body — body documents item tabs number Tabs item, Add envelope archive metadata — request body — body documents item tabs radio Group Tabs item, Add envelope archive metadata — request body — body documents item tabs prefill Tabs sender Name Tabs item, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item, Add envelope archive metadata — request body — body documents item tabs tab Groups item, Add envelope archive metadata — request body — body documents item tabs text Tabs item, Add envelope archive metadata — request body — body documents item tabs zip Tabs item
Add envelope archive metadata — request body — body documents item tabs prefill Tabs sender Name 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, `Docu Sign` 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 `Docu Sign` will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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. |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
bold | string | Optional | When **true,** the information in the tab is bold. |
boldMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
connectedObjectDetails | Model | Optional | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields 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 |
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 |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
extensionData | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data |
font | string | Optional | The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana |
fontColor | string | Optional | The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White |
fontColorMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
fontSize | string | Optional | The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 |
fontSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
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 |
italic | string | Optional | When **true,** the information in the tab is italic. |
italicMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
localePolicy | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy |
mergeField | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field |
mergeFieldXml | string | Optional | Reserved for Docusign. |
name | string | Optional | |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
recipientId | string | Optional | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
smartContractInformation | Model | Optional | Expand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information |
source | string | Optional | Reserved for Docusign. |
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. |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
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 |
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 |
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 |
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 |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
underline | string | Optional | When **true,** the information in the tab is underlined. |
underlineMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
value | string | Optional | Specifies the value of the tab. |
valueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
warningDetails | Model | Optional | Expand Add envelope archive metadata — 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 |
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 |
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 |
Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
Add envelope archive metadata — request body — body documents item tabs radio Group Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) objects associated with the group. Only one radio button can be selected in a group. |
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 |
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 |
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 |
groupName | string | Optional | The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. |
groupNameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
originalValue | string | Optional | The initial value of the tab. |
originalValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
radios | array | Optional | Specifies the locations and status for radio buttons that are grouped together. |
radios[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item tabs radio Group Tabs item radios item |
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 |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
requireAll | string | Optional | When **true** and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
requireInitialOnSharedChange | string | Optional | Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shareToRecipients | string | Optional | Reserved for Docusign. |
shareToRecipientsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
shared | string | Optional | When **true,** this custom tab is shared. |
sharedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
source | string | Optional | |
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 |
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 |
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 |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
tooltipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
value | string | Optional | Specifies the value of the tab. |
valueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — request body — body documents item tabs radio Group Tabs item radios item