Skip to content

DocuSign: Esignature schemas (part 7)

16 DocuSign schemas with complete fields and constraints.

← Esignature operations · All schemas

Add envelope archive metadata — request body — body documents item tabs radio Group Tabs item radios item

FieldTypePresenceDescription and constraints
$objectRootOne of the selectable radio buttons
in the `radios` property
of a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab.
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
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
fontstringOptionalThe font to be used for the tab value. Supported fonts include:

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

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

- Size7
- Size8
- Size9
- Size10
- Size11
- Size12
- Size14
- Size16
- Size18
- Size20
- Size22
- Size24
- Size26
- Size28
- Size36
- Size48
- Size72
fontSizeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
italicstringOptionalWhen **true,** the information in the tab is italic.
italicMetadataModelOptionalExpand Updates a template document — response body — name Metadata
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
mergeFieldXmlstringOptionalReserved for Docusign.
pageNumberstringOptionalSpecifies the page number on which the tab is located.
Must be 1 for supplemental documents.
pageNumberMetadataModelOptionalExpand 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
selectedstringOptionalWhen **true,** the radio button is selected.
selectedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
statusstringOptionalIndicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later.
statusMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabFullyQualifiedPathstringOptional
tabIdstringOptionalThe unique identifier for the tab.
tabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
tabOrderstringOptionalA positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
tabOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
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
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 sign Here Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that allows the recipient to sign a document. May be
optional.
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.

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

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

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

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

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

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

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

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

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

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

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
formOrderstringOptionalAn integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
handDrawRequiredstringOptionalWhen set to `true`, requires a hand-drawn signature by the signer.
heightstringOptionalNot applicable to Sign Here tab.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
isSealSignTabstringOptionalWhen **true,** the tab contains a visual representation for an electronic seal in a document.
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe name of the tab. For example, `Sign Here` or `Initial Here`.

If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
optionalstringOptionalWhen **true,** the recipient does not need to complete this tab to complete the signing process.
optionalMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalSpecifies the page number on which the tab is located.
Must be 1 for supplemental documents.
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
scaleValuestringOptionalScales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size.
scaleValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
smartContractInformationModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information
sourcestringOptionalReserved for Docusign.
stampModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs sign Here Tabs item stamp
stampTypestringOptionalThe type of stamp. Valid values are:

- `signature`: A signature image. This is the default value.
- `stamp`: A stamp image.
- null
stampTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
statusstringOptionalThe status of the tab. Possible values are:

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

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

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

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

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

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

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

FieldTypePresenceDescription and constraints
$objectRoot
adoptedDateTimestringOptionalThe UTC date and time when the user adopted the signature.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
customFieldstringOptional
dateStampPropertiesModelOptionalExpand Deletes the image for a stamp — response body — date Stamp Properties
disallowUserResizeStampstringOptionalWhen **true,** users may not resize the stamp.
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
externalIDstringOptionalOptionally specify an external identifier for the user's signature.
imageBase64stringOptional
imageTypestringOptionalSpecificies the type of image. Valid values:

- `stamp_image`
- `signature_image`
- `initials_image`
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
phoneticNamestringOptionalThe phonetic spelling of the `signatureName`.
signatureNamestringOptionalSpecifies the user's signature name.
stampFormatstringOptionalThe format of a stamp. Valid values are:

- `NameHanko`: The stamp represents only the signer's name.
- `NameDateHanko`: The stamp represents the signer's name and the date.
stampImageUristringOptionalThe URI for retrieving the image of the user's stamp.
stampSizeMMstringOptionalThe physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
statusstringOptionalIndicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later.

Referenced models: Deletes the image for a stamp — response body — date Stamp Properties, Add envelope archive metadata — response body — error Details

Add envelope archive metadata — request body — body documents item tabs signer Attachment Tabs item

FieldTypePresenceDescription and constraints
$objectRootA tab that allows the recipient to attach supporting
documents to an envelope.
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
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentLabelstringOptionalFor conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
conditionalParentLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
conditionalParentValuestringOptionalFor conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
conditionalParentValueMetadataModelOptionalExpand Updates a template document — response body — name Metadata
connectedObjectDetailsModelOptionalExpand Add envelope archive metadata — request body — body documents item doc Gen Form Fields item connected Object Details
customTabIdstringOptionalThe DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
customTabIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
formOrderstringOptionalAn integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
handDrawRequiredstringOptionalReserved for Docusign.
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
namestringOptionalThe name of the tab. For example, `Sign Here` or `Initial Here`.

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

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

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

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

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

To improve the tab's position on the document,
Docusign recommends
adjusting `xPosition`
and `yPosition`
coordinates
by (+0, -24)
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 (+0, -24)
yPositionMetadataModelOptionalExpand Updates a template document — response body — name Metadata

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

Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item

FieldTypePresenceDescription and constraints
$objectRoot
agreementAttributestringOptionalN/A - do not use
agreementAttributeLockedstringOptionalN/A - do not use
anchorAllowWhiteSpaceInCharactersstringOptionalWhen **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.

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

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

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

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

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

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

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

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

This functionality uses the following rules:

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

$~><|^+=

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

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

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

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

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

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

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

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

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

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

- `pixels` (default)
- `inches`
- `mms`
- `cms`
anchorUnitsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorXOffsetstringOptionalSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
anchorXOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
anchorYOffsetstringOptionalSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
anchorYOffsetMetadataModelOptionalExpand Updates a template document — response body — name Metadata
captionstringOptional
captionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
caseSensitivebooleanOptionalWhen **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML.
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
displaySettingsModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item display Settings
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
endAnchorstringOptionalSpecifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.

**Note:** A start anchor, an end anchor, or both are required.
endPositionModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item end Position
errorDetailsModelOptionalExpand Add envelope archive metadata — response body — error Details
extensionDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data
formOrderstringOptionalAn integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
formOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageLabelstringOptionalA string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
formPageLabelMetadataModelOptionalExpand Updates a template document — response body — name Metadata
formPageNumberstringOptionalAn integer specifying the order in which to present the guided form pages.
formPageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
heightMetadataModelOptionalExpand Updates a template document — response body — name Metadata
lockedstringOptionalWhen **true,** the signer cannot change the data of the custom tab.
lockedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
mergeFieldModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field
mergeFieldXmlstringOptionalReserved for Docusign.
overlayTypestringOptionalThe type of overlay to draw on the document. The following overlay types are supported:

- `line`
- `outline`
overlayTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pageNumberstringOptionalSpecifies the page number on which the tab is located.
pageNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdstringOptionalThe ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
recipientIdGuidstringOptionalThe globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
recipientIdGuidMetadataModelOptionalExpand Updates a template document — response body — name Metadata
recipientIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
removeEndAnchorbooleanOptionalWhen **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.
removeStartAnchorbooleanOptionalWhen **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.
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.
startAnchorstringOptionalSpecifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.

**Note:** A start anchor, an end anchor, or both are required.
startPositionModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item end Position
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.
tabOrderstringOptionalA positive integer that sets the order the tab is navigated to during signing.

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

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

Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item display Settings

FieldTypePresenceDescription and constraints
$objectRootThese properties define how a Smart Section displays. A Smart Section is a type of display section.
cellStylestringOptionalSpecifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types.
collapsibleSettingsModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item display Settings collapsible Settings
displaystringOptionalIndicates the display type. Must be one of the following enum values:

- **inline:** Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page.
- **collapsible:** The HTML in the section may be expanded or collapsed. By default, the section is expanded.
- **collapsed:** The HTML in the section may be expanded or collapsed. By default, the section is collapsed.
- **responsive_table:** Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions.
- **responsive_table_single_column:** Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. The table is converted to a single column in which each column becomes a row and is stacked.
- **print_only:** Prevents this portion of the HTML from displaying in the responsive signing view.
displayLabelstringOptionalThe label to add to this display section in the signing page.
displayOrderintegerOptionalThe position on the page where the display section appears.
displayPageNumberintegerOptionalThe number of the page on which the display section appears.
hideLabelWhenOpenedbooleanOptionalWhen **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`.
inlineOuterStylestringOptionalSpecifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`.
labelWhenOpenedstringOptionalThe label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`.
preLabelstringOptionalEnables you to add descriptive text that appears before a collapsed section or continue button.
scrollToTopWhenOpenedbooleanOptionalWhen **true** and the section is expanded,
the position of the section-close control
scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.
tableStylestringOptionalSpecifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`.

Referenced models: Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item display Settings collapsible Settings

Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item display Settings collapsible Settings

FieldTypePresenceDescription and constraints
$objectRoot
arrowClosedstringOptionalIndicates the direction of the disclosure arrow
when the collapsible section is in the closed state.

One of the following:

- `up`: In the closed state, the disclosure arrow points up.
- `down`: In the closed state, the disclosure arrow points down.
- `left`: In the closed state, the disclosure arrow points left.
- `right`: In the closed state, the disclosure arrow points right.
arrowColorstringOptionalA CSS color value (such as `#DCF851`) that indicates the color of the arrow.
arrowLocationstringOptionalThe location of the arrow relative to the collapsible section's label. Possible values are:

- `right` (default)
- `left`
arrowOpenstringOptionalIndicates the direction of the disclosure arrow
when the collapsible section is in the open state.

One of the following:

- `up`: In the open state, the disclosure arrow points up.
- `down`: In the open state, the disclosure arrow points down.
- `left`: In the open state, the disclosure arrow points left.
- `right`: In the open state, the disclosure arrow points right.
arrowSizestringOptionalIndicates the size of the collapsible arrows. Possible values are:

- `small`
- `large` (default)
arrowStylestringOptionalThe name of the CSS style to be used on collapsible arrow section.
containerStylestringOptionalThe name of the CSS style to be used for the collapsible container.
labelStylestringOptionalThe name of the CSS style to be used for the collapsible container's label.
onlyArrowIsClickablebooleanOptionalWhen **true,** only the arrow is clickable to expand or collapse the section.
When **false** (the default), both the label and the arrow are clickable.

If no arrow is used, this setting is ignored.
outerLabelAndArrowStylestringOptionalThe name of the CSS style to be used for the collapsible container's outer label and arrow style.

Add envelope archive metadata — request body — body documents item tabs smart Section Tabs item end Position

FieldTypePresenceDescription and constraints
$objectRoot
pageNumberintegerOptionalSpecifies the page number on which the tab is located.
xPositionnumberOptionalThis 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.
Format: double
yPositionnumberOptionalThis 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.
Format: double

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

FieldTypePresenceDescription and constraints
$objectRootA one-line field that allows the recipient to enter a Social
Security Number. The SSN can be typed with or without
dashes. It uses the same parameters as a Text tab, with the
validation message and pattern set for SSN information.
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
- 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 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 (-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 ssn Tabs item extension Data

FieldTypePresenceDescription and constraints
$objectRoot
actionContractstringOptionalThe template that defines the action in an extension app.
actionInputKeystringOptionalA key that represents the input data required for verification. The value of this property determines the actual data type to be verified. The supported values are:

- `countryCode`
- `phoneNumber`
- `street1`
- `locality`
- `subdivision`
- `email`
- `firstName`
- `lastName`
- `vin`
- `ssn`
- `countryOrRegion`
- `fein`
- `businessName`
- `postalCode`
- `accountNumber`
- `accountType`
- `routingNumber`
- `dateOfBirth`
- `stateOfRegistration`
- `countryOfRegistration`
actionNamestringOptionalThe name of an action used in an extension app.
applicationIdstringOptionalThe unique ID of an extension app.
applicationNamestringOptionalThe name of an extension app.
connectedFieldsDataModelOptionalExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data connected Fields Data
connectionInstancesarrayOptionalAn object containing data that identifies an extension app's connection to the connected field.
connectionInstances[]ModelEach itemExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data connection Instances item
extensionContractstringOptionalThe template that defines the extension in an extension app. This corresponds to the extension template value in the extension app's manifest file.
extensionGroupIdstringOptionalThe unique ID of the group of extensions within an extension app.
extensionNamestringOptionalThe name of the extension used in an extension app.
extensionPolicystringOptionalAn envelope or account-level configuration that determines a document's signing policy.
Set this to property value to `mustVerifyToSign` to require that this text tab must be validated by an extension app before the envelope can be completed.
publisherNamestringOptionalThe name of the extension app publisher.
requiredForExtensionstringOptionalA boolean value that indicates whether a field must pass verification before a signer can sign a document.

Referenced models: Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data connected Fields Data, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data connection Instances item

Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data connected Fields Data

FieldTypePresenceDescription and constraints
$objectRoot
propertyNamestringOptionalAn identifier describing input data for a connected field.
supportedOperationstringOptionalThe type of operation used to verify a connected field.
supportedUristringOptionalThe URI used to verify a connected field.
typeNamestringOptionalThe name of the verification type used in a connected field.
typeSystemNamespacestringOptionalThe type of operation used during verification.

Add envelope archive metadata — request body — body documents item tabs ssn Tabs item extension Data connection Instances item

FieldTypePresenceDescription and constraints
$objectRoot
connectionKeystringOptionalA key used to identify the connection instance of an extension app.
connectionValuestringOptionalThe GUID value that identifies the connection instance of an extension app.

Add envelope archive metadata — request body — body documents item tabs ssn Tabs item locale Policy

FieldTypePresenceDescription and constraints
$objectRootAllows you to customize locale settings.
addressFormatstringOptionalSpecifies the address format. Valid values:

- `en_us`
- `ja_jp`
- `zh_cn_tw`
calendarTypestringOptionalSpecifies the type of calendar. Valid values:

- `gregorian`
- `japanese`
- `buddhist`
cultureNamestringOptionalThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
currencyCodestringOptionalThe [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.

Supported formats:

- `AED`
- `AFN`
- `ALL`
- `AMD`
- `ANG`
- `AOA`
- `ARS`
- `AUD`
- `AWG`
- `AZN`
- `BAM`
- `BBD`
- `BDT`
- `BGN`
- `BHD`
- `BIF`
- `BMD`
- `BND`
- `BOB`
- `BOV`
- `BRL`
- `BSD`
- `BTN`
- `BWP`
- `BYN`
- `BYR`
- `BZD`
- `CAD`
- `CDF`
- `CHE`
- `CHF`
- `CHW`
- `CLF`
- `CLP`
- `CNY`
- `COP`
- `COU`
- `CRC`
- `CUC`
- `CUP`
- `CVE`
- `CZK`
- `DJF`
- `DKK`
- `DOP`
- `DZD`
- `EGP`
- `ERN`
- `ETB`
- `EUR`
- `FJD`
- `FKP`
- `GBP`
- `GEL`
- `GHS`
- `GIP`
- `GMD`
- `GNF`
- `GTQ`
- `GYD`
- `HKD`
- `HNL`
- `HRK`
- `HTG`
- `HUF`
- `IDR`
- `ILS`
- `INR`
- `IQD`
- `IRR`
- `ISK`
- `JMD`
- `JOD`
- `JPY`
- `KES`
- `KGS`
- `KHR`
- `KMF`
- `KPW`
- `KRW`
- `KWD`
- `KYD`
- `KZT`
- `LAK`
- `LBP`
- `LKR`
- `LRD`
- `LSL`
- `LYD`
- `MAD`
- `MDL`
- `MGA`
- `MKD`
- `MMK`
- `MNT`
- `MOP`
- `MRO`
- `MUR`
- `MVR`
- `MWK`
- `MXN`
- `MXV`
- `MYR`
- `MZN`
- `NAD`
- `NGN`
- `NIO`
- `NOK`
- `NPR`
- `NZD`
- `OMR`
- `PAB`
- `PEN`
- `PGK`
- `PHP`
- `PKR`
- `PLN`
- `PYG`
- `QAR`
- `RON`
- `RSD`
- `RUB`
- `RWF`
- `SAR`
- `SBD`
- `SCR`
- `SDG`
- `SEK`
- `SGD`
- `SHP`
- `SLL`
- `SOS`
- `SRD`
- `SSP`
- `STD`
- `SVC`
- `SYP`
- `SZL`
- `THB`
- `TJS`
- `TMT`
- `TND`
- `TOP`
- `TRY`
- `TTD`
- `TWD`
- `TZS`
- `UAH`
- `UGX`
- `USD`
- `USN`
- `UYI`
- `UYU`
- `UZS`
- `VEF`
- `VND`
- `VUV`
- `WST`
- `XAF`
- `XAG`
- `XAU`
- `XBA`
- `XBB`
- `XBC`
- `XBD`
- `XCD`
- `XDR`
- `XOF`
- `XPD`
- `XPF`
- `XPT`
- `XSU`
- `XTS`
- `XUA`
- `XXX`
- `YER`
- `ZAR`
- `ZMW`
- `ZWL`
currencyNegativeFormatstringOptionalDetermines how negative currency values
are displayed.

In most cases, you should not need to change
this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).

Valid values:

- `Default`
`0`
- `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`
`($1,234,567.89)`
- `Minus_CSym_1_Comma_234_Comma_567_Period_89`
`-$1,234,567.89`
- `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`
`-$ 1.234.567,89`
- `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`
`$ -1.234.567,89`
- `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`
`-1.234.567,89 $`
- `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`
`(1 234 567,89 $)`
- `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`
`-1 234 567,89 $`
- `CSym_Minus_1_Quote_234_Quote_567_Period_89`
`$-1'234'567.89`
- `Minus_CSym_1_Period_234_Period_567_Comma_89`
`-$1.234.567,89`
- `Minus_CSym_1_Comma_234_Comma_567`
`-$1,234,567`
- `Minus_CSym_12_Comma_34_Comma_567_Period_89`
`-$12,34,567.89`
- `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`
`($ 1234,567.89)`
- `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`
`$ -12,34,567.89`
- `CSym_Minus_12_Comma_34_Comma_567_Period_89`
`$-1,234,567.89`
- `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`
`$ -1 234 567,89`
- `CSym_Space_Minus_1_Space_234_Space_567_Period_89`
`$ -1 234 567.89`
- `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`
`-$ 1 234 567,89`
- `Minus_1_Space_234_Space_567_Comma_89_CSym`
`-1 234 567,89$`
- `Minus_1_Space_234_Space_567_Period_89_Space_CSym`
`-1 234 567.89 $`
- `OPar_CSym_1_Period_234_Period_567_CPar`
`(1.234.567)`
- `OPar_CSym_1_Comma_234_Comma_567_CPar`
`($1,234,567)`
- `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`
`-1,234,567.89 $`
- `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`
`-$ 1,234,567.89`
- `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`
`($ 1.234.567,89)`
- `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`
`($ 1'234'567.89)`
- `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`
`($ 1 234 567,89)`
- `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`
`($ 1 234 567.89)`
- `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`
`($12,34,567.89)`
- `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`
`($ 12,34,567.89)`
- `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`
`(1,234,567.89 $)`
- `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`
`(1.234.567,89 $)`
- `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`
`(1 234 567,89$)`
- `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`
`(1 234 567.89 $)`
- `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`
`($ 1,234,567.89)`
- `Minus_CSym_1_Period_234_Period_567`
`-$ 1.234.567`
- `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`
`-$ 1'234'567.89`
- `Minus_CSym_Space_1_Space_234_Space_567_Period_89`
`-$ 1 234 567.89`
- `CSym_Minus_1_Comma_234_Comma_567`
`$-1,234,567`
- `CSym_Minus_1_Period_234_Period_567`
`$-1.234.567`
- `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`
`$ -1'234'567.89`
- `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`
`$ -1,234,567.89`
- `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`
`-$ 12,34,567.89`
- `Minus_1_Period_234_Period_567_Space_CSym`
`-123.456.789 $`
- `CSym_Minus_1_Space_234_Space_567_Comma_89`
`$-123 456 789,00`
- `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`
`-123'456'789.00 $`
- `CSym_1_Comma_234_Comma_567_Period_89_Minus`
`$123,456,789.00-`
- `CSym_Minus_1_Period_234_Period_567_Comma_89`
`$-123.456.789,00`
- `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`
`($123.456.789,00)`
- `Minus_CSym_1234_Comma_567_Period_89`
`-$123456,789.00`
- `Minus_CSym_1_Space_234_Space_567_Comma_89`
`-$123 456 789,00`
currencyPositiveFormatstringOptionalDetermines how positive currency values
are displayed.

In most cases, you should not need to change
this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).

Valid values:

- `Default`

Uses the current locale.
- `CSym_1_Comma_234_Comma_567_Period_89`
`$1,234,567.89`
- `CSym_Space_1_Period_234_Period_567_Comma_89`
`$ 1.234.567,89`
- `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`
`1.234.567,89 $`
- `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`
`1 234 567,89 $`
- `CSym_Space_1_Quote_234_Quote_567_Period_89`
`$ 1'234'567.89`
- `CSym_1_Comma_234_Comma_567`
`$1,234,567`
- `CSym_Space_12_Comma_34_Comma_567_Period_89`
`$ 12,34,567.89`
- `CSym_12_Comma_34_Comma_567_Period_89`
`$12,34,567.89`
- `CSym_Space_1234_Comma_567_Period_89`
`$ 1234,567.89`
- `Leading_1_Space_234_Space_567_Period_89_Space_CSym`
`1 234 567.89 $`
- `CSym_Space_1_Space_234_Space_567_Comma_89`
`$ 1 234 567,89`
- `CSym_Space_1_Space_234_Space_567_Period_89`
`$ 1 234 567.89`
- `Leading_1_Space_234_Space_567_Comma_89_CSym`
`1 234 567,89$`
- `CSym_1_Period_234_Period_567`
`$1.234.567`
- `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`
`1,234,567. $` (New Armenian)
- `CSym_Space_1_Comma_234_Comma_567_Period_89`
`$ 1,234,567.89` (Persian)
- `CSym_1_Period_234_Period_567_Comma_89`
`$123.456.789,00` (es-CO)
- `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`
`123'456'789.00 $` (fr-ch)
- `CSym_1234_Comma_567_Period_89`
`$123456,789.00` (es-PR)
- `Leading_1_Period_234_Period_567_Space_CSym`
`123.456.789 $`
- `CSym_1_Space_234_Space_567_Comma_89`
`$123 456 789,00` (en-ZA, es-CR)
customDateFormatstringOptional
customTimeFormatstringOptional
dateFormatstringOptionalSpecifies the date format. Valid values:

- `default`
used the UI's
- `longformat`
use the UI's long format
- `dd_mm_yy`
dd-MM-yy
- `dd_mmm_yy`
dd-MMM-yy
- `dd_mm_yyyy`
dd-MM-yyyy
- `dd_mmm_yyyy`
dd-MMM-yyyy
- `ddmmmmyyyy`
dd MMMM yyyy
- `ddmmyyyy`
dd/MM/yyyy
- `ddmmyyyy_de`
dd.MM.yyyy
- `dmyyyy`
d/M/yyyy
- `d_m_yyyy`
d-M-yyyy
- `mmmd_yyyy`
MMM d, yyyy
- `mmm_dd_yyyy`
MMM-dd-yyyy
- `mmmmd_yyyy`
MMMM d, yyyy
- `mm_dd_yyyy`
MM-dd-yyyy
- `mdyyyy`
M/d/yyyy
- `yyyy_mmm_dd`
yyyy-MMM-dd
- `yyyy_mm_dd`
yyyy-MM-dd
- `yyyymmdd`
yyyy/MM/dd
- `yyyymd`
yyyy/M/d
- `custom`
Customer set own value
- `mmddyyyy`
MM/dd/yyyy
- `mmddyy`
MM/dd/yy
- `yyyy_mmmm_d`
yyyy MMMM d
initialFormatstringOptionalWhen a user is required to enter their initials,
this property
specifies how initials are rendered.
The examples show the
initials for "William Henry Gates".

- `first1last1`
"WG"
- `last2`
"GA"
- `first2`
"WI"
- `last2_cjk`
first two characters from last name in CJK characters.
nameFormatstringOptionalDescribes how names are displayed. Valid values:

- `first_middle_last`
William Henry Gates
- `full`
Mr William Henry Gates III
- `last_first`
Gates William
- `lastfirst`
GatesWilliam
- `last_first_cjk`
Gates William only with CJK characters
- `lastfirst_cjk`
GatesWilliam only with CJK characters
timeFormatstringOptionalSpecifies the time format. Valid values:

- `none`
None
- `hh_mm`
hh:mm
- `hhmm`
HH:mm
- `hhmmss`
HH:mm:ss
- `hhmmsstt`
HH:mm:ss tt
- `hhmmtt`
HH:mm tt
- `hmm`
h:mm
- `hmmss`
h:mm:ss
- `hmmsstt`
h:mm:ss tt
- `hmmtt`
h:mm tt
- `custom`
Customer-set format
timeZonestringOptionalSpecifies the time zone. Valid values:

- `TZ_01_AfghanistanStandardTime`
- `TZ_02_AlaskanStandardTime`
- `TZ_03_ArabStandardTime`
- `TZ_04_ArabianStandardTime`
- `TZ_05_ArabicStandardTime`
- `TZ_06_ArgentinaStandardTime`
- `TZ_07_AtlanticStandardTime`
- `TZ_08_AUS_CentralStandardTime`
- `TZ_09_AUS_EasternStandardTime`
- `TZ_10_AzerbaijanStandardTime`
- `TZ_11_AzoresStandardTime`
- `TZ_12_BangladeshStandardTime`
- `TZ_13_CanadaCentralStandardTime`
- `TZ_14_CapeVerdeStandardTime`
- `TZ_15_CaucasusStandardTime`
- `TZ_16_CentralAustraliaStandardTime`
- `TZ_17_CentralAmericaStandardTime`
- `TZ_18_CentralAsiaStandardTime`
- `TZ_19_CentralBrazilianStandardTime`
- `TZ_20_CentralEuropeStandardTime`
- `TZ_21_CentralEuropeanStandardTime`
- `TZ_22_CentralPacificStandardTime`
- `TZ_23_CentralStandardTime`
- `TZ_24_CentralStandardTimeMexico`
- `TZ_25_ChinaStandardTime`
- `TZ_26_DatelineStandardTime`
- `TZ_27_E_AfricaStandardTime`
- `TZ_28_E_AustraliaStandardTime`
- `TZ_29_E_EuropeStandardTime`
- `TZ_30_E_SouthAmericaStandardTime`
- `TZ_31_EasternStandardTime`
- `TZ_32_EgyptStandardTime`
- `TZ_33_EkaterinburgStandardTime`
- `TZ_34_FijiStandardTime`
- `TZ_35_FLE_StandardTime`
- `TZ_36_GeorgianStandardTime`
- `TZ_37_GMT_StandardTime`
- `TZ_38_GreenlandStandardTime`
- `TZ_39_GreenwichStandardTime`
- `TZ_40_GTB_StandardTime`
- `TZ_41_HawaiianStandardTime`
- `TZ_42_IndiaStandardTime`
- `TZ_43_IranStandardTime`
- `TZ_44_IsraelStandardTime`
- `TZ_45_JordanStandardTime`
- `TZ_46_KaliningradStandardTime`
- `TZ_47_KamchatkaStandardTime`
- `TZ_48_KoreaStandardTime`
- `TZ_49_MagadanStandardTime`
- `TZ_50_MauritiusStandardTime`
- `TZ_51_MidAtlanticStandardTime`
- `TZ_52_MiddleEastStandardTime`
- `TZ_53_MontevideoStandardTime`
- `TZ_54_MoroccoStandardTime`
- `TZ_55_MountainStandardTime`
- `TZ_56_MountainStandardTimeMMexico`
- `TZ_57_MyanmarStandardTime`
- `TZ_58_N_CentralAsiaStandardTime`
- `TZ_59_NamibiaStandardTime`
- `TZ_60_NepalStandardTime`
- `TZ_61_NewZealandStandardTime`
- `TZ_62_NewfoundlandStandardTime`
- `TZ_63_NorthAsiaEastStandardTime`
- `TZ_64_NorthAsiaStandardTime`
- `TZ_65_PacificSAStandardTime`
- `TZ_66_PacificStandardTime`
- `TZ_67_PacificStandardTimeMexico`
- `TZ_68_PakistanStandardTime`
- `TZ_69_ParaguayStandardTime`
- `TZ_70_RomanceStandardTime`
- `TZ_71_RussianStandardTime`
- `TZ_72_SAEasternStandardTime`
- `TZ_73_SAPacificStandardTime`
- `TZ_74_SAWesternStandardTime`
- `TZ_75_SamoaStandardTime`
- `TZ_76_SE_AsiaStandardTime`
- `TZ_77_SingaporeStandardTime`
- `TZ_78_SouthAfricaStandardTime`
- `TZ_79_SriLankaStandardTime`
- `TZ_80_SyriaStandardTime`
- `TZ_81_TaipeiStandardTime`
- `TZ_82_TasmaniaStandardTime`
- `TZ_83_TokyoStandardTime`
- `TZ_84_TongaStandardTime`
- `TZ_85_TurkeyStandardTime`
- `TZ_86_UlaanbaatarStandardTime`
- `TZ_87_US_EasternStandardTime`
- `TZ_88_USMountainStandardTime`
- `TZ_89_VenezuelaStandardTime`
- `TZ_90_VladivostokStandardTime`
- `TZ_91_W_AustraliaStandardTime`
- `TZ_92_W_CentralAfricaStandardTime`
- `TZ_93_W_EuropeStandardTime`
- `TZ_94_WestAsiaStandardTime`
- `TZ_95_WestPacificStandardTime`
- `TZ_96_YakutskStandardTime`
useLongCurrencyFormatstringOptionalWhen **true,** use the long currency format for the locale.

Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field

FieldTypePresenceDescription and constraints
$objectRootContains information for transferring values between Salesforce data fields and Docusign tabs.
allowSenderToEditstringOptionalWhen **true,** the sender can modify the value of the `mergeField` tab during the sending process.
allowSenderToEditMetadataModelOptionalExpand Updates a template document — response body — name Metadata
configurationTypestringOptionalIf you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
configurationTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pathstringOptionalSets the object associated with the custom tab. Currently this is the Salesforce Object.
pathExtendedarrayOptionalReserved for Docusign.
pathExtended[]ModelEach itemExpand Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field path Extended item
pathExtendedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
pathMetadataModelOptionalExpand Updates a template document — response body — name Metadata
rowstringOptionalSpecifies the row number in a Salesforce table that the merge field value corresponds to.
rowMetadataModelOptionalExpand Updates a template document — response body — name Metadata
writeBackstringOptionalWhen **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
writeBackMetadataModelOptionalExpand Updates a template document — response body — name Metadata

Referenced models: Updates a template document — response body — name Metadata, Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field path Extended item

Add envelope archive metadata — request body — body documents item tabs ssn Tabs item merge Field path Extended item

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptional
typestringOptionalThe type of this tab. Values are:

- `Approve`
- `CheckBox`
- `Company`
- `Date`
- `DateSigned`
- `Decline`
- `Email`
- `EmailAddress`
- `EnvelopeId`
- `FirstName`
- `Formula`
- `FullName`
- `InitialHere`
- `InitialHereOptional`
- `LastName`
- `List`
- `Note`
- `Number`
- `Radio`
- `SignerAttachment`
- `SignHere`
- `SignHereOptional`
- `Ssn`
- `Text`
- `Title`
- `Zip5`
- `Zip5Dash4`
typeNamestringOptional

Add envelope archive metadata — request body — body documents item tabs ssn Tabs item smart Contract Information

FieldTypePresenceDescription and constraints
$objectRoot
codestringOptionalReserved for Docusign.
uristringOptionalReserved for Docusign.

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.