DocuSign: Esignature schemas (part 30)
14 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Returns tabs on a template — response body — sign Here Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab that allows the recipient to sign a document. May be optional. |
agreementAttribute | string | Optional | |
agreementAttributeLocked | string | Optional | |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorCaseSensitive` property is editable. |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. |
anchorMatchWholeWord | string | Optional | When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorMatchWholeWord` property is editable. |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorString` property is editable. |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorUnits` property is editable. |
anchorXOffset | string | Optional | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorXOffset` property is editable. |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorYOffset` property is editable. |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `caption` property is editable. |
conditionalParentLabel | string | Optional | For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentLabel` property is editable. |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentValue` property is editable. |
connectedObjectDetails | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item connected Object Details |
customTabId | string | Optional | The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
customTabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `customTabId` property is editable. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `documentId` property is editable. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
extensionData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formOrder` property is editable. |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formPageLabel` property is editable. |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fromPageNumber` property is editable. |
handDrawRequired | string | Optional | Reserved for Docusign. |
height | string | Optional | Not applicable to Sign Here tab. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `height` property is editable. |
isSealSignTab | string | Optional | When **true,** the tab contains a visual representation for an electronic seal in a document. |
mergeField | Model | Optional | Expand Creates a custom tab — response body — merge Field Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | Optional | Reserved for Docusign. |
name | string | Optional | The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `name` property is editable. This property is read-only. |
optional | string | Optional | When **true,** the recipient does not need to complete this tab to complete the signing process. |
optionalMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `optional` property is editable. |
pageNumber | string | Optional | Specifies the page number on which the tab is located. Must be 1 for supplemental documents. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `pageNumber` property is editable. |
recipientId | string | Optional | The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientIdGuid` property is editable. |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientId` property is editable. |
scaleValue | string | Optional | Scales 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. |
scaleValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `scaleValue` property is editable. |
smartContractInformation | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item smart Contract Information Reserved for Docusign. |
source | string | Optional | Reserved for Docusign. |
stamp | Model | Optional | Expand Returns tabs on a template — response body — sign Here Tabs item stamp |
stampType | string | Optional | The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null |
stampTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `stampType` property is editable. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `status` property is editable. |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabGroupLabels` property is editable. |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabId` property is editable. |
tabLabel | string | Optional | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabLabel` property is editable. |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabOrder` property is editable. |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabType` property is editable. |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateLocked` property is editable. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateRequired` property is editable. |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `toolTip` property is editable. |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
warningDetails | Model | Optional | Expand Locks a template — response body — error Details |
width | string | Optional | Not applicable to Sign Here tab. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `width` property is editable. |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+1, -7) |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `xPosition` property is editable. |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+1, -7) |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `yPosition` property is editable. |
Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information, Returns tabs on a template — response body — sign Here Tabs item stamp
Returns tabs on a template — response body — sign Here Tabs item stamp
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adoptedDateTime | string | Optional | The UTC date and time when the user adopted the signature. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customField | string | Optional | |
dateStampProperties | Model | Optional | Expand Deletes the image for a stamp — response body — date Stamp Properties Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. |
disallowUserResizeStamp | string | Optional | When **true,** users may not resize the stamp. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
externalID | string | Optional | Optionally specify an external identifier for the user's signature. |
imageBase64 | string | Optional | |
imageType | string | Optional | Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image` |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
phoneticName | string | Optional | The phonetic spelling of the `signatureName`. |
signatureName | string | Optional | Specifies the user's signature name. |
stampFormat | string | Optional | The 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. |
stampImageUri | string | Optional | The URI for retrieving the image of the user's stamp. |
stampSizeMM | string | Optional | The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. |
status | string | Optional | Indicates 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, Locks a template — response body — error Details
Returns tabs on a template — response body — signer Attachment Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab that allows the recipient to attach supporting documents to an envelope. |
agreementAttribute | string | Optional | |
agreementAttributeLocked | string | Optional | |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorCaseSensitive` property is editable. |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. |
anchorMatchWholeWord | string | Optional | When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorMatchWholeWord` property is editable. |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorString` property is editable. |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorUnits` property is editable. |
anchorXOffset | string | Optional | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorXOffset` property is editable. |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorYOffset` property is editable. |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `caption` property is editable. |
conditionalParentLabel | string | Optional | For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentLabel` property is editable. |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentValue` property is editable. |
connectedObjectDetails | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item connected Object Details |
customTabId | string | Optional | The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
customTabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `customTabId` property is editable. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `documentId` property is editable. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
extensionData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formOrder` property is editable. |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formPageLabel` property is editable. |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fromPageNumber` property is editable. |
handDrawRequired | string | Optional | Reserved for Docusign. |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `height` property is editable. |
mergeField | Model | Optional | Expand Creates a custom tab — response body — merge Field Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | Optional | Reserved for Docusign. |
name | string | Optional | The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `name` property is editable. This property is read-only. |
optional | string | Optional | When **true,** the recipient does not need to complete this tab to complete the signing process. |
optionalMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `optional` property is editable. |
pageNumber | string | Optional | The page number on which the tab is located. For supplemental documents, this value must be `1`. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `pageNumber` property is editable. |
recipientId | string | Optional | The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientIdGuid` property is editable. |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientId` property is editable. |
scaleValue | string | Optional | Sets 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. |
scaleValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `scaleValue` property is editable. |
smartContractInformation | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item smart Contract Information Reserved for Docusign. |
source | string | Optional | Reserved for Docusign. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `status` property is editable. |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabGroupLabels` property is editable. |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabId` property is editable. |
tabLabel | string | Optional | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabLabel` property is editable. |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabOrder` property is editable. |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabType` property is editable. |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateLocked` property is editable. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateRequired` property is editable. |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `toolTip` property is editable. |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
warningDetails | Model | Optional | Expand Locks a template — response body — error Details |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `width` property is editable. |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `xPosition` property is editable. |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `yPosition` property is editable. |
Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information
Returns tabs on a template — response body — smart Section Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agreementAttribute | string | Optional | |
agreementAttributeLocked | string | Optional | |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorCaseSensitive` property is editable. |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. |
anchorMatchWholeWord | string | Optional | When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorMatchWholeWord` property is editable. |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorString` property is editable. |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorUnits` property is editable. |
anchorXOffset | string | Optional | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorXOffset` property is editable. |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorYOffset` property is editable. |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `caption` property is editable. |
caseSensitive | boolean | Optional | When **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML. |
conditionalParentLabel | string | Optional | For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentLabel` property is editable. |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentValue` property is editable. |
connectedObjectDetails | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item connected Object Details |
customTabId | string | Optional | The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
customTabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `customTabId` property is editable. |
displaySettings | Model | Optional | Expand Returns tabs on a template — response body — smart Section Tabs item display Settings This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `documentId` property is editable. |
endAnchor | string | Optional | Specifies 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. |
endPosition | Model | Optional | Expand Returns tabs on a template — response body — smart Section Tabs item end Position The last index position in the result set. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
extensionData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formOrder` property is editable. |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formPageLabel` property is editable. |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fromPageNumber` property is editable. |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `height` property is editable. |
locked | string | Optional | When **true,** the signer cannot change the data of the custom tab. |
lockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `locked` property is editable. |
mergeField | Model | Optional | Expand Creates a custom tab — response body — merge Field Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | Optional | Reserved for Docusign. |
overlayType | string | Optional | The type of overlay to draw on the document. The following overlay types are supported: - `line` - `outline` |
overlayTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `overlayType` property is editable. |
pageNumber | string | Optional | Specifies the page number on which the tab is located. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `pageNumber` property is editable. |
recipientId | string | Optional | The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientIdGuid` property is editable. |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientId` property is editable. |
removeEndAnchor | boolean | Optional | When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. |
removeStartAnchor | boolean | Optional | When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. |
shared | string | Optional | When **true,** this custom tab is shared. |
sharedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `shared` property is editable. |
smartContractInformation | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item smart Contract Information Reserved for Docusign. |
source | string | Optional | Reserved for Docusign. |
startAnchor | string | Optional | Specifies 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. |
startPosition | Model | Optional | Expand Returns tabs on a template — response body — smart Section Tabs item end Position The starting index position of the current result set. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `status` property is editable. |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabGroupLabels` property is editable. |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabId` property is editable. |
tabLabel | string | Optional | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabOrder` property is editable. |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabType` property is editable. |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateLocked` property is editable. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateRequired` property is editable. |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `toolTip` property is editable. |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
warningDetails | Model | Optional | Expand Locks a template — response body — error Details |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `width` property is editable. |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `xPosition` property is editable. |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `yPosition` property is editable. |
Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information, Returns tabs on a template — response body — smart Section Tabs item end Position, Returns tabs on a template — response body — smart Section Tabs item display Settings
Returns tabs on a template — response body — smart Section Tabs item display Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | These properties define how a Smart Section displays. A Smart Section is a type of display section. |
cellStyle | string | Optional | Specifies 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. |
collapsibleSettings | Model | Optional | Expand Returns tabs on a template — response body — smart Section Tabs item display Settings collapsible Settings This object defines the appearance and function of a collapsible section or item. |
display | string | Optional | Indicates 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. |
displayLabel | string | Optional | The label to add to this display section in the signing page. |
displayOrder | JSON | Optional | |
displayOrder (anyOf 1) | integer | Alternative | The position on the page where the display section appears. Format: int32 |
displayOrder (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
displayPageNumber | JSON | Optional | |
displayPageNumber (anyOf 1) | integer | Alternative | The number of the page on which the display section appears. Format: int32 |
displayPageNumber (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hideLabelWhenOpened | boolean | Optional | When **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`. |
inlineOuterStyle | string | Optional | Specifies 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`. |
labelWhenOpened | string | Optional | The 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`. |
preLabel | string | Optional | Enables you to add descriptive text that appears before a collapsed section or continue button. |
scrollToTopWhenOpened | boolean | Optional | When **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`. |
tableStyle | string | Optional | Specifies 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: Returns tabs on a template — response body — smart Section Tabs item display Settings collapsible Settings
Returns tabs on a template — response body — smart Section Tabs item display Settings collapsible Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
arrowClosed | string | Optional | Indicates 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. |
arrowColor | string | Optional | A CSS color value (such as `#DCF851`) that indicates the color of the arrow. |
arrowLocation | string | Optional | The location of the arrow relative to the collapsible section's label. Possible values are: - `right` (default) - `left` |
arrowOpen | string | Optional | Indicates 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. |
arrowSize | string | Optional | Indicates the size of the collapsible arrows. Possible values are: - `small` - `large` (default) |
arrowStyle | string | Optional | The name of the CSS style to be used on collapsible arrow section. |
containerStyle | string | Optional | The name of the CSS style to be used for the collapsible container. |
labelStyle | string | Optional | The name of the CSS style to be used for the collapsible container's label. |
onlyArrowIsClickable | boolean | Optional | When **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. |
outerLabelAndArrowStyle | string | Optional | The name of the CSS style to be used for the collapsible container's outer label and arrow style. |
Returns tabs on a template — response body — smart Section Tabs item end Position
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
pageNumber | JSON | Optional | |
pageNumber (anyOf 1) | integer | Alternative | Specifies the page number on which the tab is located. Format: int32 |
pageNumber (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
xPosition | JSON | Optional | |
xPosition (anyOf 1) | number | Alternative | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. Format: double |
xPosition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
yPosition | JSON | Optional | |
yPosition (anyOf 1) | number | Alternative | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. Format: double |
yPosition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Returns tabs on a template — response body — ssn Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
agreementAttribute | string | Optional | |
agreementAttributeLocked | string | Optional | |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorCaseSensitive` property is editable. |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. |
anchorMatchWholeWord | string | Optional | When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorMatchWholeWord` property is editable. |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorString` property is editable. |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorUnits` property is editable. |
anchorXOffset | string | Optional | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorXOffset` property is editable. |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorYOffset` property is editable. |
bold | string | Optional | When **true,** the information in the tab is bold. |
boldMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `bold` property is editable. |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `caption` property is editable. |
concealValueOnDocument | string | Optional | When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `concealValueOnDocument` property is editable. |
conditionalParentLabel | string | Optional | For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentLabel` property is editable. |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentValue` property is editable. |
connectedObjectDetails | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item connected Object Details |
customTabId | string | Optional | The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
customTabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `customTabId` property is editable. |
disableAutoSize | string | Optional | When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. |
disableAutoSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `disableAutoSize` property is editable. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `documentId` property is editable. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
extensionData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data |
font | string | Optional | The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana |
fontColor | string | Optional | The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White |
fontColorMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fontColor` property is editable. |
fontMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `font` property is editable. |
fontSize | string | Optional | The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 |
fontSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fontSize` property is editable. |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formOrder` property is editable. |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formPageLabel` property is editable. |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fromPageNumber` property is editable. |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `height` property is editable. |
italic | string | Optional | When **true,** the information in the tab is italic. |
italicMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `italic` property is editable. |
localePolicy | Model | Optional | Expand Creates a custom tab — response body — locale Policy Locale-specific settings. |
locked | string | Optional | When **true,** the signer cannot change the data of the custom tab. |
lockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `locked` property is editable. |
maxLength | string | Optional | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `maxLength` property is editable. |
mergeField | Model | Optional | Expand Creates a custom tab — response body — merge Field Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | Optional | Reserved for Docusign. |
name | string | Optional | The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `name` property is editable. This property is read-only. |
originalValue | string | Optional | The initial value of the tab. |
originalValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `originalValue` property is editable. |
pageNumber | string | Optional | The page number on which the tab is located. For supplemental documents, this value must be `1`. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `pageNumber` property is editable. |
recipientId | string | Optional | The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientIdGuid` property is editable. |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientId` property is editable. |
requireAll | string | Optional | When **true** and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `requireAll` property is editable. |
requireInitialOnSharedChange | string | Optional | Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. |
required | string | Optional | When **true,** the signer is required to fill out this tab. |
requiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `required` property is editable. |
senderRequired | string | Optional | When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. |
senderRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `senderRequired` property is editable. |
shareToRecipients | string | Optional | Reserved for Docusign. |
shareToRecipientsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
shared | string | Optional | When **true,** this custom tab is shared. |
sharedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `shared` property is editable. |
smartContractInformation | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item smart Contract Information Reserved for Docusign. |
source | string | Optional | Reserved for Docusign. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `status` property is editable. |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabGroupLabels` property is editable. |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabId` property is editable. |
tabLabel | string | Optional | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabLabel` property is editable. |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabOrder` property is editable. |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabType` property is editable. |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateLocked` property is editable. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateRequired` property is editable. |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `toolTip` property is editable. |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
underline | string | Optional | When **true,** the information in the tab is underlined. |
underlineMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `underline` property is editable. |
validationMessage | string | Optional | The message displayed if the custom tab fails input validation (either custom of embedded). |
validationMessageMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `validationMessage` property is editable. |
validationPattern | string | Optional | A regular expression used to validate input for the tab. |
validationPatternMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `validationPattern` property is editable. |
value | string | Optional | Specifies the value of the tab. |
valueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `value` property is editable. |
warningDetails | Model | Optional | Expand Locks a template — response body — error Details |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `width` property is editable. |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `xPosition` property is editable. |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `yPosition` property is editable. |
Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — locale Policy, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information
Returns tabs on a template — response body — ssn Tabs item connected Object Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recordId | string | Optional |
Returns tabs on a template — response body — ssn Tabs item extension Data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actionContract | string | Optional | |
actionInputKey | string | Optional | |
actionName | string | Optional | |
applicationId | string | Optional | |
applicationName | string | Optional | |
connectedFieldsData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data connected Fields Data |
connectionInstances | array | Optional | |
connectionInstances[] | Model | Each item | Expand Returns tabs on a template — response body — ssn Tabs item extension Data connection Instances item |
extensionContract | string | Optional | |
extensionGroupId | string | Optional | |
extensionName | string | Optional | |
extensionPolicy | string | Optional | |
publisherName | string | Optional | |
requiredForExtension | string | Optional |
Referenced models: Returns tabs on a template — response body — ssn Tabs item extension Data connected Fields Data, Returns tabs on a template — response body — ssn Tabs item extension Data connection Instances item
Returns tabs on a template — response body — ssn Tabs item extension Data connected Fields Data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
propertyName | string | Optional | |
supportedOperation | string | Optional | |
supportedUri | string | Optional | |
typeName | string | Optional | |
typeSystemNamespace | string | Optional |
Returns tabs on a template — response body — ssn Tabs item extension Data connection Instances item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
connectionKey | string | Optional | |
connectionValue | string | Optional |
Returns tabs on a template — response body — ssn Tabs item smart Contract Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Optional | Reserved for Docusign. |
uri | string | Optional | Reserved for Docusign. |
Returns tabs on a template — response body — tab Groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agreementAttribute | string | Optional | |
agreementAttributeLocked | string | Optional | |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorCaseSensitive` property is editable. |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. |
anchorMatchWholeWord | string | Optional | When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorMatchWholeWord` property is editable. |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorString` property is editable. |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorUnits` property is editable. |
anchorXOffset | string | Optional | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorXOffset` property is editable. |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorYOffset` property is editable. |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `caption` property is editable. |
conditionalParentLabel | string | Optional | For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentLabel` property is editable. |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentValue` property is editable. |
connectedObjectDetails | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item connected Object Details |
customTabId | string | Optional | The Docusign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
customTabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `customTabId` property is editable. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `documentId` property is editable. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
extensionData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formOrder` property is editable. |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formPageLabel` property is editable. |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fromPageNumber` property is editable. |
groupLabel | string | Optional | A unique identifier for a tab group. To assign a tab to the `tabGroup`, you assign the `TabGroupLabel` to the `tab.TabGroupLabels` array. |
groupLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `groupLabel` property is editable. |
groupRule | string | Optional | Specifies how `maximumAllowed` and `minimumRequired` are interpreted when selecting tabs in a `tabGroup`. Possible values are: - `SelectAtLeast` - `SelectAtMost` - `SelectExactly` - `SelectARange` |
groupRuleMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `groupRule` property is editable. |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `height` property is editable. |
maximumAllowed | string | Optional | The maximum number of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. |
maximumAllowedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `maximumAllowed` property is editable. |
mergeField | Model | Optional | Expand Creates a custom tab — response body — merge Field Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | Optional | Reserved for Docusign. |
minimumRequired | string | Optional | The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. |
minimumRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `minimumRequired` property is editable. |
pageNumber | string | Optional | Specifies the page number on which the tab is located. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `pageNumber` property is editable. |
recipientId | string | Optional | The ID of the recipient to whom the tab group will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientIdGuid` property is editable. |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientId` property is editable. |
smartContractInformation | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item smart Contract Information Reserved for Docusign. |
source | string | Optional | Reserved for Docusign. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `status` property is editable. |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabGroupLabels` property is editable. |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabId` property is editable. |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabOrder` property is editable. |
tabScope | string | Optional | The scope of the tab group. Possible values are: - `document` - `envelope` (default) |
tabScopeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabScope` property is editable. |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabType` property is editable. |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateLocked` property is editable. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateRequired` property is editable. |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `toolTip` property is editable. |
tooltip | string | Optional | The text of a tooltip that appears when a user hovers over a form field or tab. |
validationMessage | string | Optional | The message displayed if the custom tab fails input validation (either custom of embedded). |
validationMessageMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `validationMessage` property is editable. |
warningDetails | Model | Optional | Expand Locks a template — response body — error Details |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `width` property is editable. |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `xPosition` property is editable. |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `yPosition` property is editable. |
Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information