Skip to content

DocuSign: Esignature schemas (part 5)

7 DocuSign schemas with complete fields and constraints.

← Esignature operations · All schemas

Add envelope archive metadata — request body — body documents item tabs initial Here Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that allows the recipient to initial the document. May
be optional.
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **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.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis 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.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis 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.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **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.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor 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.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe 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.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
formOrderstringOptionalAn 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.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA 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.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
handDrawRequiredstringOptionalWhen set to `true`, requires a hand-drawn initial by the signer.
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe 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.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
optionalstringOptionalWhen **true,** the recipient does not need to complete this tab to complete the signing process.
optionalMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located. For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
scaleValuestringOptionalSets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.
scaleValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe 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`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn 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[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe 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.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA 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.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis 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 (+2, -7)
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis 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 (+2, -7)
yPositionMetadataModelOptionalExpand 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 last Name Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that displays the recipient's last name. This tab
takes the recipient's name as entered in the recipient
information, splits it into sections based on spaces and
uses the last section as the last name.
agreementAttributestringOptionalWhen 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
agreementAttributeLockedstringOptionalWhen set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute.
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **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.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis 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.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis 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.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **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.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor 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.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe 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.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe font to be used for the tab value. Supported fonts include:

- Default
- Arial
- ArialNarrow
- Calibri
- CourierNew
- Garamond
- Georgia
- Helvetica
- LucidaConsole
- MSGothic
- MSMincho
- OcrA (OCR-A)
- Tahoma
- TimesNewRoman
- Trebuchet
- Verdana
fontColorstringOptionalThe font color to use for the information in the tab. Possible values are:

- Black
- BrightBlue
- BrightRed
- DarkGreen
- DarkRed
- Gold
- Green
- NavyBlue
- Purple
- White
fontColorMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontSizestringOptionalThe 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
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formOrderstringOptionalAn 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.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA 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.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
localePolicyModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe 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.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located. For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe 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`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn 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[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe 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.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA 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.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
underlinestringOptionalWhen **true,** the information in the tab is underlined.
underlineMetadataModelOptionalExpand Updates a template document — response body — name Metadata
valuestringOptionalSpecifies the value of the tab.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis 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)
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis 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)
yPositionMetadataModelOptionalExpand 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 list Tabs item

FieldTypePresenceDescription and constraints
$objectRootThis tab offers a list of options to choose from.
The `listItems`
property contains a list of
[`listItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/)
objects to specify the selectable options.
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **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.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis 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.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis 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.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **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.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor 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.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe 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.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe 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
fontColorstringOptionalThe font color to use for the information in the tab. Possible values are:

- Black
- BrightBlue
- BrightRed
- DarkGreen
- DarkRed
- Gold
- Green
- NavyBlue
- Purple
- White
fontColorMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontSizestringOptionalThe 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
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formOrderstringOptionalAn 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.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA 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.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
listItemsarrayOptionalThe list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]

Maximum Length of listItems: 2048 characters.
Maximum Length of items in the list: 100 characters.
listItems[]ModelEach itemExpand Add envelope archive metadata — request body — body documents item tabs list Tabs item list Items item
listSelectedValuestringOptionalThe value in the list that is selected by default.
listSelectedValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
localePolicyModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
originalValuestringOptionalThe initial value of the tab.
originalValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located. For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requireAllstringOptionalWhen **true** and shared is true, information must be entered in this field to complete the envelope.
requireAllMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requireInitialOnSharedChangestringOptionalOptional element for field markup. When **true,** the signer is required to initial when they modify a shared field.
requireInitialOnSharedChangeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requiredstringOptionalWhen **true,** the signer is required to fill out this tab.
requiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
senderRequiredstringOptionalWhen **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.
senderRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
shareToRecipientsstringOptionalReserved for Docusign.
shareToRecipientsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
sharedstringOptionalWhen **true,** this custom tab is shared.
sharedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe 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`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn 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[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe 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.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA 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.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
underlinestringOptionalWhen **true,** the information in the tab is underlined.
underlineMetadataModelOptionalExpand Updates a template document — response body — name Metadata
valuestringOptionalThe value to use when the item is selected.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis 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)
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis 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)
yPositionMetadataModelOptionalExpand 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 list Tabs item list Items item, 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 list Tabs item list Items item

FieldTypePresenceDescription and constraints
$objectRootOne of the selectable items
in the `listItems` property
of a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab.
selectedstringOptionalWhen **true,** indicates that this item is the default selection shown to a signer.

Only one selection can be set as the default.
selectedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
textstringOptionalSpecifies the text that is shown in the dropdown list.
textMetadataModelOptionalExpand Updates a template document — response body — name Metadata
valuestringOptionalSpecifies the value that is used when the list item is selected.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata

Referenced models: Updates a template document — response body — name Metadata

Add envelope archive metadata — request body — body documents item tabs notarize Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that alerts notary recipients that
they must take action on the page.
Only one notarize tab can appear on a page.
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **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.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis 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.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis 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.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **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.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor 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.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe 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.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
formOrderstringOptionalAn 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.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA 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.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
pageNumberstringOptionalSpecifies the page number on which the tab is located.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requiredstringOptionalWhen **true,** the signer is required to fill out this tab.
requiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe 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`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn 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[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA 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.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis 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.
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis 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.
yPositionMetadataModelOptionalExpand 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 notary Seal Tabs item

FieldTypePresenceDescription and constraints
$objectRootA Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].

[notary]: /docs/notary-api/
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **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.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis 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.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis 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.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **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.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor 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.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe 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.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
formOrderstringOptionalAn 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.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA 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.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptional
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalSpecifies the page number on which the tab is located.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
scaleValuestringOptionalSets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.
scaleValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalIndicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later.
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn 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[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe 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.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA 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.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis 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.
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis 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.
yPositionMetadataModelOptionalExpand 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 note Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that displays additional information, in the form of a
note, for the recipient.
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **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.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis 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.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis 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.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **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.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor 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.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe 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.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe 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
fontColorstringOptionalThe font color to use for the information in the tab. Possible values are:

- Black
- BrightBlue
- BrightRed
- DarkGreen
- DarkRed
- Gold
- Green
- NavyBlue
- Purple
- White
fontColorMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontSizestringOptionalThe 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
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formOrderstringOptionalAn 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.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA 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.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
localePolicyModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe 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.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located. For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
sharedstringOptionalWhen **true,** this custom tab is shared.
sharedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe 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`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn 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[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe 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.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA 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.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptional**Note:** Note tabs never display this tooltip in the signing interface.

Although you can technically set a value via the API for this tab,
it will not be displayed to the recipient.
underlinestringOptionalWhen **true,** the information in the tab is underlined.
underlineMetadataModelOptionalExpand Updates a template document — response body — name Metadata
valuestringOptionalSpecifies the value of the tab.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis 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)
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis 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)
yPositionMetadataModelOptionalExpand 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

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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