DocuSign: Esignature schemas (part 8)
12 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Add envelope archive metadata — request body — body documents item tabs tab Groups 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 |
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 |
groupLabel | string | Optional | A unique identifier for a tab group. To assign a tab to the `tabGroup`, you assign the `TabGroupLabel` to the `tab.TabGroupLabels` array. |
groupLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
groupRule | string | Optional | Specifies how `maximumAllowed` and `minimumRequired` are interpreted when selecting tabs in a `tabGroup`. Possible values are: - `SelectAtLeast` - `SelectAtMost` - `SelectExactly` - `SelectARange` |
groupRuleMetadata | 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 |
maximumAllowed | string | Optional | The maximum number of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. |
maximumAllowedMetadata | 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. |
minimumRequired | string | Optional | The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. |
minimumRequiredMetadata | 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 group 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 |
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 |
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 |
tabScope | string | Optional | The scope of the tab group. Possible values are: - `document` - `envelope` (default) |
tabScopeMetadata | 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. |
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 |
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 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 text Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab that allows the recipient to enter any type of text. |
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 | A description of the tab that can match the original document caption or describe its intent. When a Web Form is generated from a template this value will be used as the caption of the field shown on the form. |
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 | The `shared` and `shareToRecipients` properties work together to define signing behavior. If `"shared": "true"`, it overrides `shareToRecipients`, and the tab is shared with all recipients. In mixed cases, the API prioritizes `"shared": "true"` for all recipients, or `"shared": "false"` for specified recipients. |
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 | The value of the text tab. Maximum length: 4000 bytes. |
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 title Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab that displays the recipient's title. |
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 | 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 |
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 | 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 |
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 view Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This tab is used with the Approve tab to handle supplemental documents. |
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 |
buttonText | string | Optional | The text to display on the button. |
buttonTextMetadata | 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. |
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 |
required | string | Optional | When **true,** the recipient must click the **View** button for the supporting document prior to completing the signing process. |
requiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
requiredRead | string | Optional | When **true,** the recipient must read through the document. |
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 |
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 zip Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. |
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 | 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 | A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. |
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 |
useDash4 | string | Optional | When **true,** ZIP+4 format is used. |
useDash4Metadata | 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 email Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. *Example*: if your account has BCC for Email Archive set up for the email address 'archive@example.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@example.com', then a copy of the envelope is only sent to the 'salesarchive@example.com' email address. |
bccEmailAddresses | array | Optional | An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters. While this property is an array, note that it takes only a single email address. **Note:** Only users with the `canManageAccount` setting set to **true** can use this option. Docusign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. **Example:** if your account has BCC for Email Archive set up for the email address [archive@example.com](mailto:archive@example.com) and you send an envelope using the BCC Email Override to send a BCC email to [salesarchive@example.com](mailto:salesarchive@example.com), then a copy of the envelope is only sent to the [salesarchive@example.com](mailto:salesarchive@example.com) email address. |
bccEmailAddresses[] | Model | Each item | Expand Add envelope archive metadata — request body — body email Settings bcc Email Addresses item |
replyEmailAddressOverride | string | Optional | The Reply To email address to use for email replies, instead of the one that is configured at the account level. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters. |
replyEmailNameOverride | string | Optional | The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters. |
Referenced models: Add envelope archive metadata — request body — body email Settings bcc Email Addresses item
Add envelope archive metadata — request body — body email Settings bcc Email Addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the BCC email address. |
bccEmailAddressId | string | Optional | Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. Example: If your account has BCC for Email Archive set up for the email address 'archive@example.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@example.com', then a copy of the envelope is only sent to the 'salesarchive@example.com' email address. |
email | string | Optional | Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope. Maximum of length: 100 characters. |
Add envelope archive metadata — request body — body envelope Custom Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
envelopeCustomMetadataDetails | array | Optional | |
envelopeCustomMetadataDetails[] | Model | Each item | Expand Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item |
Referenced models: Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item
Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A name-value pair that describes an item and provides a value for the item. |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
name | string | Optional | The name of the item. |
originalValue | string | Optional | The initial value of the item. |
value | string | Optional | The current value of the item. |
Referenced models: Add envelope archive metadata — response body — error Details
Add envelope archive metadata — request body — body envelope Documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about the envelope document. |
addedRecipientIds | array | Optional | If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only. |
addedRecipientIds[] | string | Each item | |
agreementType | string | Optional | |
agreementTypeSource | string | Optional | |
attachmentTabId | string | Optional | If this document is an attachment to another document in the envelope, this is the ID of the attachment tab it is associated with on the other document. |
authoritativeCopy | string | Optional | When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** |
authoritativeCopyMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
availableDocumentTypes | array | Optional | |
availableDocumentTypes[] | Model | Each item | Expand Updates a template document — response body — available Document Types item |
containsPdfFormFields | string | Optional | When **true,** the document has editable form fields that are made available through a PDF format. |
display | string | Optional | This string sets the display and behavior properties of the document during signing. Valid values: - `modal` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. - `inline` The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents. |
displayMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
docGenDocumentStatus | string | Optional | |
docGenErrors | array | Optional | |
docGenErrors[] | Model | Each item | Expand Updates a template document — response body — doc Gen Errors item |
docGenFormFields | array | Optional | |
docGenFormFields[] | Model | Each item | Expand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item |
documentBase64 | string | Optional | The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. |
documentFields | array | Optional | An object containing information about the custom fields on the document. |
documentFields[] | Model | Each item | Expand Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item |
documentId | string | Optional | The ID of the document that the tab is placed on. This value must refer to the ID of an existing document. |
documentIdGuid | string | Optional | The GUID of the document. |
documentTemplateId | string | Optional | |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
hasDigitalSignature | string | Optional | |
includeInDownload | string | Optional | When **true,** the document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/). The default value is **true.** |
includeInDownloadMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
isAceGenDocument | string | Optional | |
isDocGenDocument | string | Optional | |
isEdited | string | Optional | |
isExternallyAvailable | string | Optional | |
isFlattened | string | Optional | |
name | string | Optional | The document's file name. Example: `Q1-Report.docx` |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
order | string | Optional | The order in which to sort the results. Valid values are: - `asc`: Ascending order. - `desc`: Descending order. |
pages | array | Optional | An array of page objects that contain information about the pages in the document. |
pages[] | Model | Each item | Expand Add envelope archive metadata — request body — body envelope Documents item pages item |
signerMustAcknowledge | string | Optional | Sets how the signer interacts with the supplemental document. Valid values: - `no_interaction` No recipient action is required. - `view` The recipient is required to view the document. - `accept` The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. - `view_accept` The recipient is required to view and accept the document. |
signerMustAcknowledgeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata |
sizeBytes | string | Optional | |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
type | string | Optional | The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` |
uri | string | Optional | The URI for retrieving the document. |
Referenced models: Updates a template document — response body — doc Gen Errors item, Updates a template document — response body — name Metadata, Updates a template document — response body — available Document Types item, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item, Add envelope archive metadata — request body — body envelope Custom Metadata envelope Custom Metadata Details item, Add envelope archive metadata — request body — body envelope Documents item pages item
Add envelope archive metadata — request body — body envelope Documents item pages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Description of a page of a document. |
dpi | string | Optional | The number of dots per inch used for the page image. |
errorDetails | Model | Optional | Expand Add envelope archive metadata — response body — error Details |
height | string | Optional | The height of the page in pixels. Must be an integer. |
imageBytes | string | Optional | The number of image bytes. |
mimeType | string | Optional | The MIME type. |
pageId | string | Optional | The ID of the page. |
sequence | string | Optional | The sequence of the page in the document, or page number. |
width | string | Optional | The width of the page in pixels. Must be an integer. |
Referenced models: Add envelope archive metadata — response body — error Details
Add envelope archive metadata — request body — body envelope Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowAdvancedCorrect | string | Optional | Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature. |
allowCorrect | string | Optional | Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information. |
enableSignWithNotary | string | Optional | Specifies if Docusign eNotary service is enabled for the envelope. |