Skip to content

DocuSign: Esignature schemas (part 4)

11 DocuSign schemas with complete fields and constraints.

← Esignature operations · All schemas

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

FieldTypePresenceDescription and constraints
$objectRootA tab that allows the recipient to enter an email address.
This is a one-line field that checks that a valid email
address is entered. It uses the same parameters as a Text
tab, with the validation message and pattern set for email
information.

When getting information that includes
this tab type, the original value of the tab when the
associated envelope was sent is included in the response.
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.

First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match.

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

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are :

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

**Note:** You can only specify the value of this property in POST requests.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
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
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
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
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe font to be used for the tab value. Supported fonts include:

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

- Black
- BrightBlue
- BrightRed
- DarkGreen
- DarkRed
- Gold
- Green
- NavyBlue
- Purple
- White
fontColorMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontSizestringOptionalThe font size used for the information in the tab. Possible values are:

- Size7
- Size8
- Size9
- Size10
- Size11
- Size12
- Size14
- Size16
- Size18
- Size20
- Size22
- Size24
- Size26
- Size28
- Size36
- Size48
- Size72
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formOrderstringOptionalAn integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
localePolicyModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
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
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe name of the tab. For example, `Sign Here` or `Initial Here`.

If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
originalValuestringOptionalThe initial value of the tab.
originalValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located.
For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requireAllstringOptionalWhen **true** and shared is true, information must be entered in this field to complete the envelope.
requireAllMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requireInitialOnSharedChangestringOptionalOptional element for field markup. When **true,** the signer is required to initial when they modify a shared field.
requireInitialOnSharedChangeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requiredstringOptionalWhen **true,** the signer is required to fill out this tab.
requiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
senderRequiredstringOptionalWhen **true,** the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
senderRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
shareToRecipientsstringOptionalReserved for Docusign.
shareToRecipientsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
sharedstringOptionalWhen **true,** this tab is shared.
sharedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe status of the tab. Possible values are:

- `active`: The tab is active, but the recipient has not yet interacted with it.
- `signed`: The recipient signed the tab.
- `declined`: The recipient declined the envelope.
- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.

To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
tabGroupLabels[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe label associated with the tab. This value may be an empty string.
If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
underlinestringOptionalWhen **true,** the information in the tab is underlined.
underlineMetadataModelOptionalExpand Updates a template document — response body — name Metadata
validationMessagestringOptionalThe message displayed if the custom tab fails input validation (either custom of embedded).
validationMessageMetadataModelOptionalExpand Updates a template document — response body — name Metadata
validationPatternstringOptionalA regular expression used to validate input for the tab.
validationPatternMetadataModelOptionalExpand Updates a template document — response body — name Metadata
valuestringOptionalSpecifies the value of the tab.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis property indicates the horizontal offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (-3, -2)
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis property indicates the vertical offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (-3, -2)
yPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata

Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information

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

FieldTypePresenceDescription and constraints
$objectRootA tab that displays the envelope ID.

**Note:** The eSignature API uses the name `envelopeId` two ways:

- As a _property_ of type `string` used to identify an envelope by its GUID.
- As an _object_ used to represent an envelope tab that displays
the envelope's GUID.
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, `Docu Sign` will not match.

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

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are :

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

**Note:** You can only specify the value of this property in POST requests.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe font to be used for the tab value. Supported fonts include:

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

- Black
- BrightBlue
- BrightRed
- DarkGreen
- DarkRed
- Gold
- Green
- NavyBlue
- Purple
- White
fontColorMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontSizestringOptionalThe font size used for the information in the tab. Possible values are:

- Size7
- Size8
- Size9
- Size10
- Size11
- Size12
- Size14
- Size16
- Size18
- Size20
- Size22
- Size24
- Size26
- Size28
- Size36
- Size48
- Size72
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formOrderstringOptionalAn integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
localePolicyModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe name of the tab. For example, `Sign Here` or `Initial Here`.

If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located.
For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe status of the tab. Possible values are:

- `active`: The tab is active, but the recipient has not yet interacted with it.
- `signed`: The recipient signed the tab.
- `declined`: The recipient declined the envelope.
- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.

To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
tabGroupLabels[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe label associated with the tab. This value may be an empty string.
If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
underlinestringOptionalWhen **true,** the information in the tab is underlined.
underlineMetadataModelOptionalExpand Updates a template document — response body — name Metadata
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis property indicates the horizontal offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis property indicates the vertical offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.
yPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata

Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information

Add envelope archive metadata — request body — body documents item tabs first Name Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that displays the recipient's first name. This tab
takes the recipient's name as entered in the recipient
information, splits it into sections based on spaces and
uses the first section as the first name.
agreementAttributestringOptionalWhen the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:

- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)
- `ContactEmail`: the contact’s email address
- `ContactName`: the contact’s name
- `ContractValue`: the monetary value of the contract
- `EffectiveDate`: the contract’s effective date
- `ExpirationDate`: the contract’s expiration date
- `Party`: one of the parties to the agreement
- `RenewalNoticePeriod`: the renewal notice period for the contract
- `RenewalTerm`: the renewal term for the contract
agreementAttributeLockedstringOptionalWhen set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute.
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.

First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match.

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

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are :

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

**Note:** You can only specify the value of this property in POST requests.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe font to be used for the tab value. Supported fonts include:

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

- Black
- BrightBlue
- BrightRed
- DarkGreen
- DarkRed
- Gold
- Green
- NavyBlue
- Purple
- White
fontColorMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontSizestringOptionalThe font size used for the information in the tab. Possible values are:

- Size7
- Size8
- Size9
- Size10
- Size11
- Size12
- Size14
- Size16
- Size18
- Size20
- Size22
- Size24
- Size26
- Size28
- Size36
- Size48
- Size72
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formOrderstringOptionalAn integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
localePolicyModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe name of the tab. For example, `Sign Here` or `Initial Here`.

If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located. For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe status of the tab. Possible values are:

- `active`: The tab is active, but the recipient has not yet interacted with it.
- `signed`: The recipient signed the tab.
- `declined`: The recipient declined the envelope.
- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.

To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
tabGroupLabels[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe label associated with the tab. This value may be an empty string.
If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
underlinestringOptionalWhen **true,** the information in the tab is underlined.
underlineMetadataModelOptionalExpand Updates a template document — response body — name Metadata
valuestringOptionalSpecifies the value of the tab.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis property indicates the horizontal offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (-3, -2)
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis property indicates the vertical offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (-3, -2)
yPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata

Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information

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

FieldTypePresenceDescription and constraints
$objectRootThe value of a formula tab is calculated
from the values of other
number or date tabs in the document.
When the recipient completes the underlying fields,
the formula tab calculates and displays the result.

The `formula` property of the tab
contains the references
to the underlying tabs.
See [Calculated Fields][calculatedfields]
in the DocuSign Support Center
to learn more about formulas.

If a formula tab contains
a `paymentDetails` property,
the tab is considered a payment item.
See [Requesting Payments Along with Signatures][paymentguide]
in the DocuSign Support Center
to learn more about payments.

[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields
[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.

First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match.

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

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are :

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

**Note:** You can only specify the value of this property in POST requests.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
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
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
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
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extendPaymentConfigurationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs formula Tabs item extend Payment Configuration
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe font to be used for the tab value. Supported fonts include:

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

- Black
- BrightBlue
- BrightRed
- DarkGreen
- DarkRed
- Gold
- Green
- NavyBlue
- Purple
- White
fontColorMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontSizestringOptionalThe font size used for the information in the tab. Possible values are:

- Size7
- Size8
- Size9
- Size10
- Size11
- Size12
- Size14
- Size16
- Size18
- Size20
- Size22
- Size24
- Size26
- Size28
- Size36
- Size48
- Size72
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formOrderstringOptionalAn integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html)
in the Docusign Support Center
to learn more about formulas.

Maximum Length: 2000 characters
formulaMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
hiddenstringOptionalIf this is a regular formula (no `paymentDetails` property is present):

- **true:** The tab is hidden.
- **false:** The tab is shown.

If the formula is payment item (a `paymentDetails` property is present):

- **true:** The tab is displayed as a payment.
- **false:** The tab is displayed as a regular formula.
hiddenMetadataModelOptionalExpand Updates a template document — response body — name Metadata
isPaymentAmountstringOptionalWhen set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.
isPaymentAmountMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
localePolicyModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
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
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe name of the tab. For example, `Sign Here` or `Initial Here`.

If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
originalValuestringOptionalThe initial value of the tab.
originalValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located. For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
paymentDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requireAllstringOptionalWhen **true** and shared is true, information must be entered in this field to complete the envelope.
requireAllMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requireInitialOnSharedChangestringOptionalOptional element for field markup. When **true,** the signer is required to initial when they modify a shared field.
requireInitialOnSharedChangeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
requiredstringOptionalWhen **true,** the signer is required to fill out this tab.
requiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
roundDecimalPlacesstringOptionalThe number of decimal places to round to.
roundDecimalPlacesMetadataModelOptionalExpand Updates a template document — response body — name Metadata
senderRequiredstringOptionalWhen **true,** the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
senderRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
shareToRecipientsstringOptionalReserved for Docusign.
shareToRecipientsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
sharedstringOptionalWhen **true,** this custom tab is shared.
sharedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe status of the tab. Possible values are:

- `active`: The tab is active, but the recipient has not yet interacted with it.
- `signed`: The recipient signed the tab.
- `declined`: The recipient declined the envelope.
- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.

To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
tabGroupLabels[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe label associated with the tab. This value may be an empty string.
If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
underlinestringOptionalWhen **true,** the information in the tab is underlined.
underlineMetadataModelOptionalExpand Updates a template document — response body — name Metadata
validationMessagestringOptionalThe message displayed if the custom tab fails input validation (either custom of embedded).
validationMessageMetadataModelOptionalExpand Updates a template document — response body — name Metadata
validationPatternstringOptionalA regular expression used to validate input for the tab.
validationPatternMetadataModelOptionalExpand Updates a template document — response body — name Metadata
valuestringOptionalSpecifies the value of the tab.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis property indicates the horizontal offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (+35, -2)
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis property indicates the vertical offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (+35, -2)
yPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata

Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs formula Tabs item extend Payment Configuration, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information

Add envelope archive metadata — request body — body documents item tabs formula Tabs item extend Payment Configuration

FieldTypePresenceDescription and constraints
$objectRoot
appIdstringOptional
connectionInstanceIdstringOptional
currencystringOptional
durationEndstringOptional
durationStartstringOptional
lineItemsarrayOptional
lineItems[]ModelEach itemExpand Add envelope archive metadata — request body — body documents item tabs formula Tabs item extend Payment Configuration line Items item
paymentDueDaysstringOptionalFormat: int32
paymentMethodsarrayOptional
paymentMethods[]stringEach item
paymentModestringOptional
tabRolestringOptional

Referenced models: Add envelope archive metadata — request body — body documents item tabs formula Tabs item extend Payment Configuration line Items item

Add envelope archive metadata — request body — body documents item tabs formula Tabs item extend Payment Configuration line Items item

FieldTypePresenceDescription and constraints
$objectRoot
amountReferencestringOptional
descriptionstringOptional
namestringOptional
priceIdstringOptional
productIdstringOptional
quantitystringOptionalFormat: int32
typestringOptional
unitAmountstringOptionalFormat: int32

Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details

FieldTypePresenceDescription and constraints
$objectRootWhen a formula tab
has a `paymentDetails` property,
the formula tab
is a payment item.
See [Requesting Payments Along with Signatures][paymentguide]
in the DocuSign Support Center
to learn more about payments.

[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures
allowedPaymentMethodsarrayOptionalAn array of accepted payment methods:

- `CreditCard`
- `ApplePay`
- `AndroidPay`
- `BankAccount`

For example, if you only accept credit cards and ACH transfers, you would set this property to:

`'["BankAccount", "CreditCard"]'`

Do not specify `BankAccount` (ACH) if you are also using in-person signing.
allowedPaymentMethods[]stringEach item
chargeIdstringOptionalThe GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.
currencyCodestringOptionalSpecifies the three-letter
[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment.

Supported currencies are:

- AUD: Australian dollar
- CAD: Canadian dollar
- EUR: Euro
- GBP: Great Britain pound
- USD: United States dollar

Specifying any other ISO 4217 code for payments is an error.
currencyCodeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
customMetadatastringOptionalThis is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under **Description** in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports.

The following example shows what the **Description** field of the transaction will look like:

`<envelopeID>, <customMetadata>`
customMetadataRequiredbooleanOptionalA sender-defined field that specifies whether custom metadata is required for the transaction. When **true,** custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account.
customerIdstringOptionalThe customer ID.
gatewayAccountIdstringOptionalA GUID that identifies the payment gateway
connected to the sender's Docusign account.

There is no public API
for connecting payment gateway accounts
You must connect and manage payment gateway accounts
through the Docusign Admin console
and through your chosen payment gateway.

You can get the gateway account ID
in the Payments section
of the Docusign Admin console.
gatewayAccountIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
gatewayDisplayNamestringOptionalDisplay name of the gateway connected to sender's Docusign account.

Possible values are: Stripe, Braintree, Authorize.Net, CyberSource, Zuora, Elavon.
gatewayNamestringOptionalName of the gateway connected to sender's Docusign account.

Possible values are:

- `Stripe`
- `Braintree`
- `AuthorizeDotNet`
- `CyberSource`
- `Zuora`
- `Elavon`
lineItemsarrayOptionalA payment formula can have
one or more line items
that provide detail about
individual items in a payment request.

The list of line items
are returned as metadata
to the payment gateway.
lineItems[]ModelEach itemExpand Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details line Items item
paymentOptionstringOptionalThis property specifies how the signer's collected payment details will be used.

Valid values:

- `authorize`: The payment details will be used to collect payment. This is the default value.
- `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.
- `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment.
paymentSourceIdstringOptionalThe payment source ID.
signerValuesModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details signer Values
statusstringOptionalThis read-only property describes the status of a payment.

- `new`

This is a new payment request.
The envelope has been created,
but no payment authorizations have been made.

- `auth_complete`

A recipient has entered their credit card information,
but the envelope has not been completed.
The card has not been charged.

- `payment_complete`

The recipient's card has been charged.

- `payment_capture_failed`

Final charge failed.
This can happen when too much time
passes between authorizing the payment
and completing the document.

- `future_payment_saved`

The recipient's payment method has been saved to the sender's payment gateway.
subGatewayNamestringOptional
totalModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details total

Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details total, Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details line Items item, Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details signer Values

Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details line Items item

FieldTypePresenceDescription and constraints
$objectRootA line item describes details
about an individual line item
in a payment request.

amountReferencestringOptionalThis is a the `tabLabel`
that specifies the amount paid
for the line items.
descriptionstringOptionalA sender-defined description of the line item.
itemCodestringOptionalThis is the sender-defined
SKU, inventory number, or other item code
for the line item.
namestringOptionalThis is a sender-defined
product name, service name,
or other designation for the line item.

Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details signer Values

FieldTypePresenceDescription and constraints
$objectRoot
paymentOptionstringOptionalThis property specifies how the signer's collected payment details will be used.

Valid values:

- `authorize`: The payment details will be used to collect payment. This is the default value.
- `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.
- `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment.

Add envelope archive metadata — request body — body documents item tabs formula Tabs item payment Details total

FieldTypePresenceDescription and constraints
$objectRootDescribes information
about the `total` of a payment.
amountInBaseUnitstringOptionalThe total payment amount
in the currency's base unit.
For example, for USD
the base currency is one cent.
currencystringOptionalThe three-letter
[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment.

For example:

- AUD Australian dollar
- CAD Canadian dollar
- EUR Euro
- GBP Great Britain pound
- USD United States dollar

This is a read-only property.
displayAmountstringOptionalThe payment amount as displayed
in the `currency`.

For example, if the payment amount
is USD 12.59,
the `amountInBaseUnit` is 1259 (cents),
and the displayed amount is `$12.59 USD`.

This is a read-only property.

Add envelope archive metadata — request body — body documents item tabs full Name Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that displays the recipient's full name.
agreementAttributestringOptionalWhen the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:

- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)
- `ContactEmail`: the contact’s email address
- `ContactName`: the contact’s name
- `ContractValue`: the monetary value of the contract
- `EffectiveDate`: the contract’s effective date
- `ExpirationDate`: the contract’s expiration date
- `Party`: one of the parties to the agreement
- `RenewalNoticePeriod`: the renewal notice period for the contract
- `RenewalTerm`: the renewal term for the contract
agreementAttributeLockedstringOptionalWhen set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute.
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.

First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match.

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

The default value is **true.**
anchorAllowWhiteSpaceInCharactersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorCaseSensitivestringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~>&lt;|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorCaseSensitiveMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorHorizontalAlignmentstringOptionalThis property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are :

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

**Note:** You can only specify the value of this property in POST requests.
anchorHorizontalAlignmentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorIgnoreIfNotPresentstringOptionalWhen **true,** this tab is ignored if the `anchorString` is not found in the document.
anchorIgnoreIfNotPresentMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorMatchWholeWordstringOptionalWhen **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.**

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

This functionality uses the following rules:

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

$~>&lt;|^+=

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

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

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

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

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

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

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

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

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

**Note:** You can only specify the value of this property in POST requests.
anchorMatchWholeWordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorStringstringOptionalSpecifies the string to find in the document and use as the basis for tab placement.
anchorStringMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabProcessorVersionstringOptionalReserved for Docusign.
anchorTabProcessorVersionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorTabScopestringOptional
anchorUnitsstringOptionalSpecifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
boldstringOptionalWhen **true,** the information in the tab is bold.
boldMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe font to be used for the tab value. Supported fonts include:

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

- Black
- BrightBlue
- BrightRed
- DarkGreen
- DarkRed
- Gold
- Green
- NavyBlue
- Purple
- White
fontColorMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontMetadataModelOptionalExpand Updates a template document — response body — name Metadata
fontSizestringOptionalThe font size used for the information in the tab. Possible values are:

- Size7
- Size8
- Size9
- Size10
- Size11
- Size12
- Size14
- Size16
- Size18
- Size20
- Size22
- Size24
- Size26
- Size28
- Size36
- Size48
- Size72
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formOrderstringOptionalAn integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
localePolicyModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe name of the tab. For example, `Sign Here` or `Initial Here`.

If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalThe page number on which the tab is located. For supplemental documents, this value must be `1`.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
statusstringOptionalThe status of the tab. Possible values are:

- `active`: The tab is active, but the recipient has not yet interacted with it.
- `signed`: The recipient signed the tab.
- `declined`: The recipient declined the envelope.
- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabGroupLabelsarrayOptionalAn array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.

To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
tabGroupLabels[]stringEach item
tabGroupLabelsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabLabelstringOptionalThe label associated with the tab. This value may be an empty string.
If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.
tabLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
tabTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateLockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
templateRequiredMetadataModelOptionalExpand Updates a template document — response body — name Metadata
toolTipMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tooltipstringOptionalThe text of a tooltip that appears when a user hovers over a form field or tab.
underlinestringOptionalWhen **true,** the information in the tab is underlined.
underlineMetadataModelOptionalExpand Updates a template document — response body — name Metadata
valuestringOptionalSpecifies the value of the tab.
valueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
warningDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
widthMetadataModelOptionalExpand Updates a template document — response body — name Metadata
xPositionstringOptionalThis property indicates the horizontal offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (-3, -2)
xPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
yPositionstringOptionalThis property indicates the vertical offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (-3, -2)
yPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata

Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — response body — error Details, Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information

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.