Skip to content

DocuSign: Esignature schemas (part 28)

6 DocuSign schemas with complete fields and constraints.

← Esignature operations · All schemas

Returns tabs on a template — response body — 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.
agreementAttributestringOptional
agreementAttributeLockedstringOptional
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, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match.

Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match.

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorCaseSensitive` property is editable.
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :

- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
- `right`: Aligns the tab’s left side with the last character of the matching anchor word.

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**

For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).


**Note:** You can only specify the value of this property in POST requests.

[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
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
Metadata that indicates whether the `anchorString` property is editable.
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
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
Metadata that indicates whether the `anchorUnits` property is editable.
anchorXOffsetstringOptionalSpecifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorXOffset` property is editable.
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorYOffset` property is editable.
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `bold` property is editable.
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `caption` property is editable.
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
Metadata that indicates whether the `conditionalParentLabel` property is editable.
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
Metadata that indicates whether the `conditionalParentValue` property is editable.
connectedObjectDetailsModelOptionalExpand Returns tabs on a template — response body — ssn Tabs 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
Metadata that indicates whether the `customTabId` property is editable.
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
Metadata that indicates whether the `documentId` property is editable.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
extensionDataModelOptionalExpand Returns tabs on a template — response body — 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
Metadata that indicates whether the `fontColor` property is editable.
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `font` property is editable.
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
Metadata that indicates whether the `fontSize` property is editable.
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
Metadata that indicates whether the `formOrder` property is editable.
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
Metadata that indicates whether the `formPageLabel` property is editable.
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `fromPageNumber` property is editable.
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `height` property is editable.
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `italic` property is editable.
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 Returns tabs on a template — response body — 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
Metadata that indicates whether the `listSelectedValue` property is editable.
localePolicyModelOptionalExpand Creates a custom tab — response body — locale Policy
Locale-specific settings.
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `locked` property is editable.
mergeFieldModelOptionalExpand Creates a custom tab — response body — merge Field
Contains the information necessary to map the tab to a field in SalesForce.
mergeFieldXmlstringOptionalReserved for Docusign.
originalValuestringOptionalThe initial value of the tab.
originalValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `originalValue` property is editable.
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
Metadata that indicates whether the `pageNumber` property is editable.
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
Metadata that indicates whether the `recipientIdGuid` property is editable.
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientId` property is editable.
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
Metadata that indicates whether the `requireAll` property is editable.
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
Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.
requiredstringOptionalWhen **true,** the signer is required to fill out this tab.
requiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `required` property is editable.
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
Metadata that indicates whether the `senderRequired` property is editable.
shareToRecipientsstringOptionalReserved for Docusign.
shareToRecipientsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
sharedstringOptionalWhen **true,** this custom tab is shared.
sharedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `shared` property is editable.
smartContractInformationModelOptionalExpand Returns tabs on a template — response body — ssn Tabs item smart Contract Information
Reserved for Docusign.
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
Metadata that indicates whether the `status` property is editable.
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
Metadata that indicates whether the `tabGroupLabels` property is editable.
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabId` property is editable.
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
Metadata that indicates whether the `tabLabel` property is editable.
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
Metadata that indicates whether the `tabOrder` property is editable.
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabType` property is editable.
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
Metadata that indicates whether the `templateLocked` property is editable.
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
Metadata that indicates whether the `templateRequired` property is editable.
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `toolTip` property is editable.
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
Metadata that indicates whether the `underline` property is editable.
valuestringOptionalThe value to use when the item is selected.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `value` property is editable.
warningDetailsModelOptionalExpand Locks a template — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `width` property is editable.
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
Metadata that indicates whether the `xPosition` property is editable.
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
Metadata that indicates whether the `yPosition` property is editable.

Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Returns tabs on a template — response body — list Tabs item list Items item, Creates a custom tab — response body — locale Policy, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information

Returns tabs on a template — response body — 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
Metadata that indicates whether the `selected` property is editable.
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
Metadata that indicates whether the `value` property is editable.

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

Returns tabs on a template — response body — 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.
agreementAttributestringOptional
agreementAttributeLockedstringOptional
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, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match.

Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match.

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorCaseSensitive` property is editable.
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :

- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
- `right`: Aligns the tab’s left side with the last character of the matching anchor word.

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**

For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).


**Note:** You can only specify the value of this property in POST requests.

[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
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
Metadata that indicates whether the `anchorString` property is editable.
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
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
Metadata that indicates whether the `anchorUnits` property is editable.
anchorXOffsetstringOptionalSpecifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorXOffset` property is editable.
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorYOffset` property is editable.
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `caption` property is editable.
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
Metadata that indicates whether the `conditionalParentLabel` property is editable.
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
Metadata that indicates whether the `conditionalParentValue` property is editable.
connectedObjectDetailsModelOptionalExpand Returns tabs on a template — response body — ssn Tabs 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
Metadata that indicates whether the `customTabId` property is editable.
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
Metadata that indicates whether the `documentId` property is editable.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
extensionDataModelOptionalExpand Returns tabs on a template — response body — 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
Metadata that indicates whether the `formOrder` property is editable.
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
Metadata that indicates whether the `formPageLabel` property is editable.
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `fromPageNumber` property is editable.
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `height` property is editable.
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `locked` property is editable.
mergeFieldModelOptionalExpand Creates a custom tab — response body — merge Field
Contains the information necessary to map the tab to a field in SalesForce.
mergeFieldXmlstringOptionalReserved for Docusign.
pageNumberstringOptionalSpecifies the page number on which the tab is located.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `pageNumber` property is editable.
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
Metadata that indicates whether the `recipientIdGuid` property is editable.
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientId` property is editable.
requiredstringOptionalWhen **true,** the signer is required to fill out this tab.
requiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `required` property is editable.
smartContractInformationModelOptionalExpand Returns tabs on a template — response body — ssn Tabs item smart Contract Information
Reserved for Docusign.
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
Metadata that indicates whether the `status` property is editable.
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
Metadata that indicates whether the `tabGroupLabels` property is editable.
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabId` property is editable.
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
Metadata that indicates whether the `tabOrder` property is editable.
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabType` property is editable.
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
Metadata that indicates whether the `templateLocked` property is editable.
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
Metadata that indicates whether the `templateRequired` property is editable.
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `toolTip` property is editable.
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
warningDetailsModelOptionalExpand Locks a template — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `width` property is editable.
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
Metadata that indicates whether the `xPosition` property is editable.
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
Metadata that indicates whether the `yPosition` property is editable.

Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information

Returns tabs on a template — response body — 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/
agreementAttributestringOptional
agreementAttributeLockedstringOptional
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, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match.

Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match.

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorCaseSensitive` property is editable.
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :

- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
- `right`: Aligns the tab’s left side with the last character of the matching anchor word.

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**

For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).


**Note:** You can only specify the value of this property in POST requests.

[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
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
Metadata that indicates whether the `anchorString` property is editable.
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
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
Metadata that indicates whether the `anchorUnits` property is editable.
anchorXOffsetstringOptionalSpecifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorXOffset` property is editable.
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorYOffset` property is editable.
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `caption` property is editable.
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
Metadata that indicates whether the `conditionalParentLabel` property is editable.
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
Metadata that indicates whether the `conditionalParentValue` property is editable.
connectedObjectDetailsModelOptionalExpand Returns tabs on a template — response body — ssn Tabs 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
Metadata that indicates whether the `customTabId` property is editable.
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
Metadata that indicates whether the `documentId` property is editable.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
extensionDataModelOptionalExpand Returns tabs on a template — response body — 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
Metadata that indicates whether the `formOrder` property is editable.
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
Metadata that indicates whether the `formPageLabel` property is editable.
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `fromPageNumber` property is editable.
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `height` property is editable.
mergeFieldModelOptionalExpand Creates a custom tab — response body — merge Field
Contains the information necessary to map the tab to a field in SalesForce.
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptional
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `name` property is editable. This property is read-only.
pageNumberstringOptionalSpecifies the page number on which the tab is located.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `pageNumber` property is editable.
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
Metadata that indicates whether the `recipientIdGuid` property is editable.
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientId` property is editable.
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
Metadata that indicates whether the `scaleValue` property is editable.
smartContractInformationModelOptionalExpand Returns tabs on a template — response body — ssn Tabs item smart Contract Information
Reserved for Docusign.
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
Metadata that indicates whether the `status` property is editable.
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
Metadata that indicates whether the `tabGroupLabels` property is editable.
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabId` property is editable.
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
Metadata that indicates whether the `tabLabel` property is editable.
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
Metadata that indicates whether the `tabOrder` property is editable.
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabType` property is editable.
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
Metadata that indicates whether the `templateLocked` property is editable.
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
Metadata that indicates whether the `templateRequired` property is editable.
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `toolTip` property is editable.
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
warningDetailsModelOptionalExpand Locks a template — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `width` property is editable.
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
Metadata that indicates whether the `xPosition` property is editable.
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
Metadata that indicates whether the `yPosition` property is editable.

Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information

Returns tabs on a template — response body — note Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that displays additional information, in the form of a
note, for the recipient.
agreementAttributestringOptional
agreementAttributeLockedstringOptional
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, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match.

Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match.

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorCaseSensitive` property is editable.
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :

- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
- `right`: Aligns the tab’s left side with the last character of the matching anchor word.

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**

For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).


**Note:** You can only specify the value of this property in POST requests.

[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
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
Metadata that indicates whether the `anchorString` property is editable.
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
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
Metadata that indicates whether the `anchorUnits` property is editable.
anchorXOffsetstringOptionalSpecifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorXOffset` property is editable.
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorYOffset` property is editable.
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `bold` property is editable.
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `caption` property is editable.
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
Metadata that indicates whether the `conditionalParentLabel` property is editable.
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
Metadata that indicates whether the `conditionalParentValue` property is editable.
connectedObjectDetailsModelOptionalExpand Returns tabs on a template — response body — ssn Tabs 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
Metadata that indicates whether the `customTabId` property is editable.
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
Metadata that indicates whether the `documentId` property is editable.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
extensionDataModelOptionalExpand Returns tabs on a template — response body — 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
Metadata that indicates whether the `fontColor` property is editable.
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `font` property is editable.
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
Metadata that indicates whether the `fontSize` property is editable.
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
Metadata that indicates whether the `formOrder` property is editable.
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
Metadata that indicates whether the `formPageLabel` property is editable.
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `fromPageNumber` property is editable.
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `height` property is editable.
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `italic` property is editable.
localePolicyModelOptionalExpand Creates a custom tab — response body — locale Policy
Locale-specific settings.
mergeFieldModelOptionalExpand Creates a custom tab — response body — merge Field
Contains the information necessary to map the tab to a field in SalesForce.
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
Metadata that indicates whether the `name` property is editable. This property is read-only.
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
Metadata that indicates whether the `pageNumber` property is editable.
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
Metadata that indicates whether the `recipientIdGuid` property is editable.
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientId` property is editable.
sharedstringOptionalWhen **true,** this custom tab is shared.
sharedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `shared` property is editable.
smartContractInformationModelOptionalExpand Returns tabs on a template — response body — ssn Tabs item smart Contract Information
Reserved for Docusign.
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
Metadata that indicates whether the `status` property is editable.
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
Metadata that indicates whether the `tabGroupLabels` property is editable.
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabId` property is editable.
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
Metadata that indicates whether the `tabLabel` property is editable.
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
Metadata that indicates whether the `tabOrder` property is editable.
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabType` property is editable.
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
Metadata that indicates whether the `templateLocked` property is editable.
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
Metadata that indicates whether the `templateRequired` property is editable.
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `toolTip` property is editable.
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
Metadata that indicates whether the `underline` property is editable.
valuestringOptionalSpecifies the value of the tab.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `value` property is editable.
warningDetailsModelOptionalExpand Locks a template — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `width` property is editable.
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
Metadata that indicates whether the `xPosition` property is editable.
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
Metadata that indicates whether the `yPosition` property is editable.

Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — locale Policy, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information

Returns tabs on a template — response body — number Tabs item

FieldTypePresenceDescription and constraints
$objectRootNumber tabs validate that the entered value is a number.
They do not support advanced validation or display options.
See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/)
to learn more about this tab type.
agreementAttributestringOptional
agreementAttributeLockedstringOptional
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, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match.

Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match.

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorCaseSensitive` property is editable.
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :

- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
- `right`: Aligns the tab’s left side with the last character of the matching anchor word.

**Note:** You can only specify the value of this property in POST requests.

[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**

For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.

This functionality uses the following rules:

- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:

$~><|^+=

For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`

- Strings embedded in other strings are ignored during the matching process.

- In words that have dashes, the parts separated by dashes are treated as distinct words.

Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**

- Letters with accent marks are treated as distinct characters from their unaccented counterparts.

- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.

- Unlike punctuation, numbers are not ignored when finding anchor words.

Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).


**Note:** You can only specify the value of this property in POST requests.

[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
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
Metadata that indicates whether the `anchorString` property is editable.
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
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
Metadata that indicates whether the `anchorUnits` property is editable.
anchorXOffsetstringOptionalSpecifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorXOffset` property is editable.
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `anchorYOffset` property is editable.
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `bold` property is editable.
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `caption` property is editable.
concealValueOnDocumentstringOptionalWhen **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
concealValueOnDocumentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `concealValueOnDocument` property is editable.
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
Metadata that indicates whether the `conditionalParentLabel` property is editable.
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
Metadata that indicates whether the `conditionalParentValue` property is editable.
connectedObjectDetailsModelOptionalExpand Returns tabs on a template — response body — ssn Tabs 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
Metadata that indicates whether the `customTabId` property is editable.
disableAutoSizestringOptionalWhen **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
disableAutoSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `disableAutoSize` property is editable.
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
Metadata that indicates whether the `documentId` property is editable.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
extensionDataModelOptionalExpand Returns tabs on a template — response body — 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
Metadata that indicates whether the `fontColor` property is editable.
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `font` property is editable.
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
Metadata that indicates whether the `fontSize` property is editable.
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
Metadata that indicates whether the `formOrder` property is editable.
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
Metadata that indicates whether the `formPageLabel` property is editable.
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `fromPageNumber` property is editable.
formulastringOptionalContains the formula
for calculating the value of
this tab.

Use a tab's `tabLabel`,
enclosed in brackets,
to refer to it.

For example,
you want to present the total cost
of two items, tax included.

The cost of each item is stored
in number tabs labeled Item1 and Item2.
The tax rate is in a number tab
labeled TaxRate.

The formula string for this property
would be:
`([Item1] + [Item2]) * (1 + [TaxRate])`

See [Calculated Fields][calculatedfields]
in the Docusign Support Center
to learn more about formulas.

Maximum Length: 2000 characters

[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html
formulaMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata indicating if the sender can edit the `formula` property.
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `height` property is editable.
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `italic` property is editable.
localePolicyModelOptionalExpand Creates a custom tab — response body — locale Policy
Locale-specific settings.
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `locked` property is editable.
maxLengthstringOptionalAn optional value that describes the maximum length of the property when the property is a string.
maxLengthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `maxLength` property is editable.
mergeFieldModelOptionalExpand Creates a custom tab — response body — merge Field
Contains the information necessary to map the tab to a field in SalesForce.
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
Metadata that indicates whether the `name` property is editable. This property is read-only.
originalValuestringOptionalThe initial value of the tab.
originalValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `originalValue` property is editable.
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
Metadata that indicates whether the `pageNumber` property is editable.
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
Metadata that indicates whether the `recipientIdGuid` property is editable.
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientId` property is editable.
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
Metadata that indicates whether the `requireAll` property is editable.
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
Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.
requiredstringOptionalWhen **true,** the signer is required to fill out this tab.
requiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `required` property is editable.
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
Metadata that indicates whether the `senderRequired` property is editable.
shareToRecipientsstringOptionalReserved for Docusign.
shareToRecipientsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
sharedstringOptionalWhen **true,** this custom tab is shared.
sharedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `shared` property is editable.
smartContractInformationModelOptionalExpand Returns tabs on a template — response body — ssn Tabs item smart Contract Information
Reserved for Docusign.
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
Metadata that indicates whether the `status` property is editable.
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
Metadata that indicates whether the `tabGroupLabels` property is editable.
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabId` property is editable.
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
Metadata that indicates whether the `tabLabel` property is editable.
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
Metadata that indicates whether the `tabOrder` property is editable.
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `tabType` property is editable.
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
Metadata that indicates whether the `templateLocked` property is editable.
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
Metadata that indicates whether the `templateRequired` property is editable.
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `toolTip` property is editable.
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
Metadata that indicates whether the `underline` property is editable.
validationMessagestringOptionalThe message displayed if the custom tab fails input validation (either custom of embedded).
validationMessageMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `validationMessage` property is editable.
validationPatternstringOptionalA regular expression used to validate input for the tab.
validationPatternMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `validationPattern` property is editable.
valuestringOptionalSpecifies the value of the tab.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `value` property is editable.
warningDetailsModelOptionalExpand Locks a template — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `width` property is editable.
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
Metadata that indicates whether the `xPosition` property is editable.
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
Metadata that indicates whether the `yPosition` property is editable.

Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — locale Policy, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information

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.