Retrieves information about the tabs associated with a recipient. You can make a single API call to get all the tab values and information from a given, completed envelope in addition to draft ones. Tab values can be retrieved by using the EnvelopeRecipients:list method with query parameter include_tabs set to "true".

Request

HTTP request

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

envelopeIdstring

The envelope's GUID. (For example, 93be49ab-afa0-4adf-933c-f752070d71ec).

recipientIdstring

The recipientId used when the envelope or template was created.

Optional Query Parameters
include_anchor_tab_locationsstring

When set to true, all tabs with anchor tab properties are included in the response. If you do not specify this parameter, the effect is the default behavior (false).

include_metadatastring

When set to true, metadata that indicates if the fields are editable are included in the response.

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeRecipientTabs
400

Error encountered.

errorDetails

SDK Method

Envelopes::listTabs

Definitions

approve

A tab that allows the recipient to approve documents without placing a signature or initials on the document.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Metadata that indicates whether the anchorTabProcessorVersion property is editable.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

buttonTextstring

Specifies the approval text that displays in the tab.

buttonTextMetadatapropertyMetadata

Metadata that indicates if the sender can edit the buttonText property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

The DocuSign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

pageNumberstring

Specifies the page number on which the tab is located. For supplemental documents, this value must be 1.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. The tab element uses this id to indicate which recipient is to sign the document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

checkbox

A tab that allows the recipient to select a yes/no (on/off) option.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid of the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requiredstring

This property does not apply to checkbox tabs. Check boxes are always optional.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

selectedstring

When set to true, the checkbox is selected.

selectedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the selected property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

comment

envelopeIdstring

The Guid of the envelope the comment thread belongs to.

hmacstring

Reserved for DocuSign.

idstring

The unique identifier for the comment.

mentions[array]

An array of userIds that are mentioned directly in the body of a comment.

readboolean

When true, indicates that the comment was read.

sentByEmailstring

The email address of the user who created the comment.

sentByFullNamestring

The full name of the user who created the comment.

sentByImageIdstring

Reserved for DocuSign.

sentByInitialsstring

The initials of the user who created the comment.

sentByRecipientIdstring

The recipient id of the user who created the comment.

sentByUserIdstring

The user id of the user who created the comment.

signingGroupIdstring

The id of the signing group that can view the comment or that created the comment.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

subjectstring

The subject of the envelope.

tabIdstring

The unique identifier for the tab that represents the comment thread.

textstring

The content of the comment, as UTF-8 text.

Maximum Length: 500 characters.

Note: The maximum size allowed for the entire message body is 32 KB.

threadIdstring

The unique identifier for the comment thread.

threadOriginatorIdstring

The userId of the user who created the thread.

timestampstring

The time the comment was created.

timeStampFormattedstring

The time the comment was created, formatted according to the format of the user who created the comment.

visibleTo[array]

The user ids of the users that the comment is visible to.

commentThread

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Metadata that indicates whether the anchorTabProcessorVersion property is editable.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

comments[comment]

An array of comment tabs that contain information about users' comments on documents.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

The ID of the document being accessed.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the item.

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

threadIdstring

The unique identifier for the comment thread.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

company

A tab that displays the recipient's company name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

date

A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

The unique id for the recipient. It is used by the tab element to indicate which recipient is to sign the document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

senderRequiredstring

When set to 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.

senderRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

dateSigned

A tab that displays the date that the recipient signed the document.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

decline

A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

buttonTextstring

Specifies the decline text displayed in the tab.

buttonTextMetadatapropertyMetadata

Metadata that indicates if the sender can edit the buttonText property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

declineReasonstring

The reason the recipient declined the document.

declineReasonMetadatapropertyMetadata

Metadata that indicates if the sender can edit the declineReason property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

email

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

When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

senderRequiredstring

When set to 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.

senderRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

emailAddress

A tab that displays the recipient's email as entered in the recipient information.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

The DocuSign-generated custom tab id for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

envelopeId

A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

firstName

A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

formulaTab

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

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

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

formulastring

Contains the formula for calculating the value of this tab.

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

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

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

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

See Calculated Fields in the DocuSign Support Center to learn more about formulas.

Maximum Length: 2000 characters

formulaMetadatapropertyMetadata

Metadata indicating if the sender can edit the formula property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

hiddenstring

If this is a regular formula (no paymentDetails property is present):

  • true: The tab is hidden.
  • false: The tab is shown.

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

  • true: The tab is displayed as a payment.
  • false: The tab is displayed as a regular formula.

hiddenMetadatapropertyMetadata

Metadata that indicates if the sender can edit the hidden property.

isPaymentAmountstring

When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.

isPaymentAmountMetadatapropertyMetadata

Metadata that indicates if the sender can edit the isPaymentAmount property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

paymentDetailspaymentDetails

This property indicates that this formula tab is a payment item.
See Requesting Payments Along with Signatures in the DocuSign Support Center to learn more about payments.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

roundDecimalPlacesstring

The number of decimal places to round to.

roundDecimalPlacesMetadatapropertyMetadata

Metadata that indicates if the sender can edit the roundDecimalPlaces property.

senderRequiredstring

When set to 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.

senderRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

fullName

A tab that displays the recipient's full name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

graphicsContext

fillColorstring

The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a friendly CSS color name.

lineColorstring

The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a friendly CSS color name.

lineWeightstring

The line weight or thickness to use for the overlay.

initialHere

A tab that allows the recipient to initial the document. May be optional.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

Specifies the tool tip text for the tab.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates if the sender can edit the optional property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

scaleValuestring

Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.

scaleValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the scaleValue property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

lastName

A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

list

This tab offers a list of options to choose from. The listItems property contains a list of listItem objects to specify the selectable options.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

listItems[listItem]

The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]

Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters.

listSelectedValuestring

The value in the list that is selected by default.

listSelectedValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the listSelectedValue property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

senderRequiredstring

When set to 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.

senderRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

The value to use when the item is selected.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

listItem

One of the selectable items in the listItems property of a list tab.

selectedstring

When set to true, indicates that this item is the default selection shown to a signer.

Only one selection can be set as the default.

selectedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the selected property.

textstring

Specifies the text that is shown in the dropdown list.

textMetadatapropertyMetadata

valuestring

Specifies the value that is used when the list item is selected.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

localePolicyTab

addressFormatstring

calendarTypestring

cultureNamestring

currencyNegativeFormatstring

currencyPositiveFormatstring

customDateFormatstring

customTimeFormatstring

dateFormatstring

initialFormatstring

nameFormatstring

timeFormatstring

timeZonestring

mergeField

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

allowSenderToEditstring

When true, the sender can modify the value of the mergeField tab during the sending process.

allowSenderToEditMetadatapropertyMetadata

Metadata that indicates if the sender can edit the allowSenderToEdit property.

configurationTypestring

If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.

configurationTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the configurationType property.

pathstring

Sets the object associated with the custom tab. Currently this is the Salesforce Object.

pathExtended[pathExtendedElement]

Reserved for DocuSign.

pathExtendedMetadatapropertyMetadata

Reserved for DocuSign.

pathMetadatapropertyMetadata

Metadata that indicates whether the path property is editable.

rowstring

Specifies the row number in a Salesforce table that the merge field value corresponds to.

rowMetadatapropertyMetadata

Metadata that indicates whether the row property is editable.

writeBackstring

When true, data entered into the merge field during Signing will update the mapped Salesforce field.

writeBackMetadatapropertyMetadata

Metadata that indicates if the sender can edit the writeBack property.

money

Describes information about the total of a payment.

amountInBaseUnitstring

The total payment amount in the currency's base unit. For example, for USD the base currency is one cent.

currencystring

The three-letter ISO 4217 currency code for the payment.

For example:

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

This is a read-only property.

displayAmountstring

The payment amount as displayed in the currency.

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

This is a read-only property.

notarize

A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

The ID of the document being accessed.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

note

A tab that displays additional information, in the form of a note, for the recipient.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

number

A tab that allows the recipient to enter numbers and decimal (.) points.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

formulastring

Contains the formula for calculating the value of this tab.

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

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

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

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

See Calculated Fields in the DocuSign Support Center to learn more about formulas.

Maximum Length: 2000 characters

formulaMetadatapropertyMetadata

Metadata indicating if the sender can edit the formula property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

isPaymentAmountstring

When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.

isPaymentAmountMetadatapropertyMetadata

Metadata that indicates if the sender can edit the isPaymentAmount property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

Specifies the tool tip text for the tab.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

senderRequiredstring

When set to 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.

senderRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

pathExtendedElement

namestring

typestring

Type of user:

  • type_owner
  • type_participant

typeNamestring

paymentDetails

When a formula tab has a paymentDetails property, the formula tab is a payment item. See Requesting Payments Along with Signatures in the DocuSign Support Center to learn more about payments.

allowedPaymentMethods[array]

An array of accepted payment methods:

  • CreditCard
  • ApplePay
  • AndroidPay
  • BankAccount

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

'["BankAccount", "CreditCard"]'

Do not specify BankAccount (ACH) if you are also using in-person signing.

chargeIdstring

The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The chargeId is created when authorizing a payment and must be referenced when completing a payment.

currencyCodestring

Specifies the three-letter ISO 4217 currency code for the payment.

Supported currencies are:

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

Specifying any other ISO 4217 code for payments is an error.

currencyCodeMetadatapropertyMetadata

gatewayAccountIdstring

A GUID that identifies the payment gateway connected to the sender's DocuSign account.

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

You can get the gateway account ID in the Payments section of the DocuSign Admin console.

gatewayAccountIdMetadatapropertyMetadata

gatewayDisplayNamestring

Display name of the gateway connected to sender's Docusign account.

Possible values are: Stripe, Braintree, Authorize.Net.

gatewayNamestring

Name of the gateway connected to sender's DocuSign account.

Possible values are:

  • Stripe
  • Braintree
  • AuthorizeDotNet

lineItems[paymentLineItem]

A payment formula can have one or more line items that provide detail about individual items in a payment request.

The list of line items are returned as metadata to the payment gateway.

paymentOptionstring

statusstring

This read-only property describes the status of a payment.

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

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

  • payment_complete
    The recipient's card has been charged.

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

totalmoney

This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields.

paymentLineItem

A line item describes details about an individual line item in a payment request.

amountReferencestring

This is a the tabLabel that specifies the amount paid for the line items.

descriptionstring

A sender-defined description of the line item.

itemCodestring

This is the sender-defined SKU, inventory number, or other item code for the line item.

namestring

This is a sender-defined product name, service name, or other designation for the line item.

polyLine

x1string

x2string

y1string

y2string

polyLineOverlay

This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

The ID of the document being accessed.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

graphicsContextgraphicsContext

Contains details about the style used for the strike through graphic.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

overlayTypestring

The type of overlay to use. The API currently supports only the outline overlay type.

overlayTypeMetadatapropertyMetadata

Metadata that indicates whether the overlayType property is editable.

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

polyLines[polyLine]

An array of polyLine objects that contain x- and y-coordinates representing the locations of the lines.

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

sharedstring

When set to true, indicates that the tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

propertyMetadata

Metadata about a property.

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

radio

One of the selectable radio buttons in the radios property of a radioGroup tab.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

selectedstring

When set to true, the radio button is selected.

selectedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the selected property.

statusstring

The status of the item.

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

radioGroup

This group tab is used to place radio buttons on a document. The radios property contains a list of radio objects associated with the group. Only one radio button can be selected in a group.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

groupNamestring

The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.

groupNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the groupName property.

radios[radio]

Specifies the locations and status for radio buttons that are grouped together.

recipientIdstring

A unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

tooltipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tooltip property.

signerAttachment

A tab that allows the recipient to attach supporting documents to an envelope.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates if the sender can edit the optional property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

scaleValuestring

A value of 1 indicates 100% of the real value.

scaleValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the scaleValue property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

signHere

A tab that allows the recipient to sign a document. May be optional.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

isSealSignTabstring

When set to true, the tab contains a visual representation for an electronic seal in a document.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

Specifies the tool tip text for the tab.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates if the sender can edit the optional property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

scaleValuestring

A value of 1 indicates 100% of normal tab size.

scaleValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the scaleValue property.

stampTypestring

If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.

stampTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the stampType property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

The signHere tab appears 21 points lower than the value you provide here. To align the tab as expected, subtract 21 from the expected y-value.

See Sign Here Tab Alignment

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

smartSection

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

caseSensitiveboolean

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

displaySettingssmartSectionDisplaySettings

documentIdstring

The ID of the document being accessed.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

endAnchorstring

endPositionsmartSectionAnchorPosition

The last position in the result set.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

overlayTypestring

overlayTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the overlayType property.

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

removeEndAnchorboolean

removeStartAnchorboolean

sharedstring

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

startAnchorstring

startPositionsmartSectionAnchorPosition

Starting position of the current result set.

statusstring

The status of the item.

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

smartSectionAnchorPosition

pageNumberinteger

The page number being accessed.

xPositionnumber

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionnumber

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

smartSectionCollapsibleDisplaySettings

arrowClosedstring

arrowColorstring

arrowLocationstring

arrowOpenstring

arrowSizestring

arrowStylestring

containerStylestring

labelStylestring

onlyArrowIsClickableboolean

outerLabelAndArrowStylestring

smartSectionDisplaySettings

cellStylestring

collapsibleSettingssmartSectionCollapsibleDisplaySettings

displaystring

This string sets the display and behavior properties of the document during signing. The possible values are:

  • modal
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents.

  • download
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window.

  • inline
    The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.

displayLabelstring

displayOrderinteger

displayPageNumberinteger

hideLabelWhenOpenedboolean

inlineOuterStylestring

labelWhenOpenedstring

scrollToTopWhenOpenedboolean

tableStylestring

ssn

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.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

Specifies the tool tip text for the tab.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

senderRequiredstring

When set to 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.

senderRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

tabGroup

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

The ID of the document being accessed.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

groupLabelstring

A unique identifier for a tab group. To assign a tab to the tabGroup, you assign the TabGroupLabel to the tab.TabGroupLabels array.

groupLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the groupLabel property.

groupRulestring

The rule that is selected by default when a user is adding validation for a tab group in the UI.

groupRuleMetadatapropertyMetadata

Metadata that indicates if the sender can edit the groupRule property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

maximumAllowedstring

The maximum number of tabs within the tabGroup that should be checked, populated, or signed. This property is used for validation.

maximumAllowedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maximumAllowed property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

minimumRequiredstring

The minimum number of of tabs within the tabGroup that should be checked, populated, or signed. This property is used for validation.

minimumRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the minimumRequired property.

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabScopestring

The scope of the tab group. Possible values are:

  • document
  • envelope (default)

tabScopeMetadatapropertyMetadata

Metadata that indicates whether the tabScope property is editable.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

text

A tab that allows the recipient to enter any type of text.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

formulastring

Contains the formula for calculating the value of this tab.

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

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

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

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

See Calculated Fields in the DocuSign Support Center to learn more about formulas.

Maximum Length: 2000 characters

formulaMetadatapropertyMetadata

Metadata indicating if the sender can edit the formula property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

isPaymentAmountstring

When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.

isPaymentAmountMetadatapropertyMetadata

Metadata that indicates if the sender can edit the isPaymentAmount property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

Specifies the tool tip text for the tab.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

senderRequiredstring

When set to 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.

senderRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

title

A tab that displays the recipient's title.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

view

This tab is used with the Approve tab to handle supplemental documents.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

buttonTextstring

The text to display on the button.

buttonTextMetadatapropertyMetadata

Metadata that indicates if the sender can edit the buttonText property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requiredstring

When set to true, the recipient must click the View button for the supporting document prior to completing the signing process.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requiredReadstring

When set to true, the recipient must read through the document.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

zip

A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

When set to 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 available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

conditionalParentValuestring

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.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentValue property.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the customTabId property.

disableAutoSizestring

When set to 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.

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the disableAutoSize property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fontstring

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

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

fontSizestring

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

fontSizeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fontSize property.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formOrder property.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireInitialOnSharedChange property.

senderRequiredstring

When set to 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.

senderRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabGroupLabels[array]

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

tabOrderstring

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.

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

useDash4string

When set to true, ZIP+4 format is used.

useDash4MetadatapropertyMetadata

Metadata that indicates whether the useDash4 property is editable.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

EnvelopeRecipientTabs

All of the tabs associated with a recipient. Each property is a list of a type of tab.

approveTabs[approve]

A list of Approve tabs.

This tab allows the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history.

checkboxTabs[checkbox]

A list of Checkbox tabs.

This tab allows the recipient to select a yes/no (on/off) option.

commentThreadTabs[commentThread]

An array of tabs that represents a collection of comments in a comment thread. For example, if a signer has questions about the content of a document, they can add a comment on the document and control who else can see the comment.

companyTabs[company]

A list of Company tabs.

This tab displays the recipient's company name.

dateSignedTabs[dateSigned]

A list of Date Signed tabs.

This tab displays the date that the recipient signed the document.

dateTabs[date]

A list of Date tabs.

This tab allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format.

declineTabs[decline]

A list of Decline tabs.

This tab allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.

emailAddressTabs[emailAddress]

A list of Email Address tabs.

This tab displays the recipient's email as entered in the recipient information.

emailTabs[email]

A list of Email tabs.

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

When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

envelopeIdTabs[envelopeId]

A list of Envelope ID tabs.

This tab displays the envelope ID. Recipients cannot enter or change the information in this tab.

firstNameTabs[firstName]

A list of First Name tabs.

This tab displays the recipient's first name. It takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.

formulaTabs[formulaTab]

A list of Formula tabs.

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

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

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

fullNameTabs[fullName]

A list of Full Name tabs.

This tab displays the recipient's full name.

initialHereTabs[initialHere]

A list of Initial Here tabs.

This tab allows the recipient to initial the document. May be optional.

lastNameTabs[lastName]

A list of Last Name tabs.

This tab displays the recipient's last name. It takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.

listTabs[list]

A list of list tabs.

This tab offers a list of options to choose from. The listItems property is used to specify the selectable options.

notarizeTabs[notarize]

A list of Notarize tabs.

A notarize tab is a tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.

noteTabs[note]

A list of Note tabs.

This tab displays additional information, in the form of a note, for the recipient.

numberTabs[number]

A list of Number tabs.

This tab allows the recipient to enter numbers and decimal (.) points.

polyLineOverlayTabs[polyLineOverlay]

A tab that allows users to add strike-through formatting to the text in a document.

radioGroupTabs[radioGroup]

A list of Radio Group tabs.

This tab This group tab is used to place radio buttons on a document. The radios property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group.

signerAttachmentTabs[signerAttachment]

A list of Signer Attachment tabs.

This tab allows the recipient to attach supporting documents to an envelope.

signHereTabs[signHere]

A list of Sign Here tabs.

This tab allows the recipient to sign a document. May be optional.

smartSectionTabs[smartSection]

ssnTabs[ssn]

A list of SSN tabs.

This tab is 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.

tabGroups[tabGroup]

An array of tabGroup items that contain information about tab groups. To assign a tab to a tabGroup, you assign the tabGroupLabel to the Tab.TabGroupLabels array.

textTabs[text]

A list of Text tabs.

This tab A tab that allows the recipient to enter any type of text.

titleTabs[title]

A list of Title tabs.

This tab displays the recipient's title.

viewTabs[view]

A list of View tabs.

This tab This tab is used with the Approve tab to handle supplemental documents.

zipTabs[zip]

A list of Zip tabs.

This tab allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.

Examples

Generic JSON Response

Response
{
  "signHereTabs": [
    {
      "stampType": "sample string 1",
      "stampTypeMetadata": {
        "rights": "sample string 1",
        "options": [
          "sample string 1"
        ]
      },
      "name": "sample string 2",
      "tabLabel": "sample string 3",
      "scaleValue": 1.1,
      "optional": "sample string 4",
      "documentId": "sample string 5",
      "recipientId": "sample string 6",
      "pageNumber": "sample string 7",
      "xPosition": "sample string 8",
      "yPosition": "sample string 9",
      "anchorString": "sample string 10",
      "anchorXOffset": "sample string 11",
      "anchorYOffset": "sample string 12",
      "anchorUnits": "sample string 13",
      "anchorIgnoreIfNotPresent": "sample string 14",
      "anchorCaseSensitive": "sample string 15",
      "anchorMatchWholeWord": "sample string 16",
      "anchorHorizontalAlignment": "sample string 17",
      "tabId": "sample string 18",
      "templateLocked": "sample string 19",
      "templateRequired": "sample string 20",
      "conditionalParentLabel": "sample string 21",
      "conditionalParentValue": "sample string 22",
      "customTabId": "sample string 23",
      "mergeField": {
        "configurationType": "sample string 1",
        "path": "sample string 2",
        "writeBack": "sample string 3",
        "allowSenderToEdit": "sample string 4",
        "row": "sample string 5"
      },
      "status": "sample string 24",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "tabOrder": "sample string 25"
    }
  ],
  "initialHereTabs": [
    {
      "name": "sample string 1",
      "tabLabel": "sample string 2",
      "scaleValue": 1.1,
      "optional": "sample string 3",
      "documentId": "sample string 4",
      "recipientId": "sample string 5",
      "pageNumber": "sample string 6",
      "xPosition": "sample string 7",
      "yPosition": "sample string 8",
      "anchorString": "sample string 9",
      "anchorXOffset": "sample string 10",
      "anchorYOffset": "sample string 11",
      "anchorUnits": "sample string 12",
      "anchorIgnoreIfNotPresent": "sample string 13",
      "anchorCaseSensitive": "sample string 14",
      "anchorMatchWholeWord": "sample string 15",
      "anchorHorizontalAlignment": "sample string 16",
      "tabId": "sample string 17",
      "templateLocked": "sample string 18",
      "templateRequired": "sample string 19",
      "conditionalParentLabel": "sample string 20",
      "conditionalParentValue": "sample string 21",
      "customTabId": "sample string 22",
      "mergeField": {},
      "status": "sample string 23",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 24"
    }
  ],
  "signerAttachmentTabs": [
    {
      "name": "sample string 1",
      "tabLabel": "sample string 2",
      "scaleValue": 1.1,
      "optional": "sample string 3",
      "documentId": "sample string 4",
      "recipientId": "sample string 5",
      "pageNumber": "sample string 6",
      "xPosition": "sample string 7",
      "yPosition": "sample string 8",
      "anchorString": "sample string 9",
      "anchorXOffset": "sample string 10",
      "anchorYOffset": "sample string 11",
      "anchorUnits": "sample string 12",
      "anchorIgnoreIfNotPresent": "sample string 13",
      "anchorCaseSensitive": "sample string 14",
      "anchorMatchWholeWord": "sample string 15",
      "anchorHorizontalAlignment": "sample string 16",
      "tabId": "sample string 17",
      "templateLocked": "sample string 18",
      "templateRequired": "sample string 19",
      "conditionalParentLabel": "sample string 20",
      "conditionalParentValue": "sample string 21",
      "customTabId": "sample string 22",
      "mergeField": {},
      "status": "sample string 23",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 24"
    }
  ],
  "approveTabs": [
    {
      "buttonText": "sample string 1",
      "width": 2,
      "height": 3,
      "tabLabel": "sample string 4",
      "font": "sample string 5",
      "bold": "sample string 6",
      "italic": "sample string 7",
      "underline": "sample string 8",
      "fontColor": "sample string 9",
      "fontSize": "sample string 10",
      "documentId": "sample string 11",
      "recipientId": "sample string 12",
      "pageNumber": "sample string 13",
      "xPosition": "sample string 14",
      "yPosition": "sample string 15",
      "anchorString": "sample string 16",
      "anchorXOffset": "sample string 17",
      "anchorYOffset": "sample string 18",
      "anchorUnits": "sample string 19",
      "anchorIgnoreIfNotPresent": "sample string 20",
      "anchorCaseSensitive": "sample string 21",
      "anchorMatchWholeWord": "sample string 22",
      "anchorHorizontalAlignment": "sample string 23",
      "tabId": "sample string 24",
      "templateLocked": "sample string 25",
      "templateRequired": "sample string 26",
      "conditionalParentLabel": "sample string 27",
      "conditionalParentValue": "sample string 28",
      "customTabId": "sample string 29",
      "mergeField": {},
      "status": "sample string 30",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 31"
    }
  ],
  "declineTabs": [
    {
      "buttonText": "sample string 1",
      "width": 2,
      "height": 3,
      "declineReason": "sample string 4",
      "tabLabel": "sample string 5",
      "font": "sample string 6",
      "bold": "sample string 7",
      "italic": "sample string 8",
      "underline": "sample string 9",
      "fontColor": "sample string 10",
      "fontSize": "sample string 11",
      "documentId": "sample string 12",
      "recipientId": "sample string 13",
      "pageNumber": "sample string 14",
      "xPosition": "sample string 15",
      "yPosition": "sample string 16",
      "anchorString": "sample string 17",
      "anchorXOffset": "sample string 18",
      "anchorYOffset": "sample string 19",
      "anchorUnits": "sample string 20",
      "anchorIgnoreIfNotPresent": "sample string 21",
      "anchorCaseSensitive": "sample string 22",
      "anchorMatchWholeWord": "sample string 23",
      "anchorHorizontalAlignment": "sample string 24",
      "tabId": "sample string 25",
      "templateLocked": "sample string 26",
      "templateRequired": "sample string 27",
      "conditionalParentLabel": "sample string 28",
      "conditionalParentValue": "sample string 29",
      "customTabId": "sample string 30",
      "mergeField": {},
      "status": "sample string 31",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 32"
    }
  ],
  "viewTabs": [
    {
      "buttonText": "sample string 1",
      "width": 2,
      "height": 3,
      "required": "sample string 4",
      "requiredRead": "sample string 5",
      "tabLabel": "sample string 6",
      "font": "sample string 7",
      "bold": "sample string 8",
      "italic": "sample string 9",
      "underline": "sample string 10",
      "fontColor": "sample string 11",
      "fontSize": "sample string 12",
      "documentId": "sample string 13",
      "recipientId": "sample string 14",
      "pageNumber": "sample string 15",
      "xPosition": "sample string 16",
      "yPosition": "sample string 17",
      "anchorString": "sample string 18",
      "anchorXOffset": "sample string 19",
      "anchorYOffset": "sample string 20",
      "anchorUnits": "sample string 21",
      "anchorIgnoreIfNotPresent": "sample string 22",
      "anchorCaseSensitive": "sample string 23",
      "anchorMatchWholeWord": "sample string 24",
      "anchorHorizontalAlignment": "sample string 25",
      "tabId": "sample string 26",
      "templateLocked": "sample string 27",
      "templateRequired": "sample string 28",
      "conditionalParentLabel": "sample string 29",
      "conditionalParentValue": "sample string 30",
      "customTabId": "sample string 31",
      "mergeField": {},
      "status": "sample string 32",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 33"
    }
  ],
  "fullNameTabs": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "tabLabel": "sample string 3",
      "font": "sample string 4",
      "bold": "sample string 5",
      "italic": "sample string 6",
      "underline": "sample string 7",
      "fontColor": "sample string 8",
      "fontSize": "sample string 9",
      "documentId": "sample string 10",
      "recipientId": "sample string 11",
      "pageNumber": "sample string 12",
      "xPosition": "sample string 13",
      "yPosition": "sample string 14",
      "anchorString": "sample string 15",
      "anchorXOffset": "sample string 16",
      "anchorYOffset": "sample string 17",
      "anchorUnits": "sample string 18",
      "anchorIgnoreIfNotPresent": "sample string 19",
      "anchorCaseSensitive": "sample string 20",
      "anchorMatchWholeWord": "sample string 21",
      "anchorHorizontalAlignment": "sample string 22",
      "tabId": "sample string 23",
      "templateLocked": "sample string 24",
      "templateRequired": "sample string 25",
      "conditionalParentLabel": "sample string 26",
      "conditionalParentValue": "sample string 27",
      "customTabId": "sample string 28",
      "mergeField": {},
      "status": "sample string 29",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 30"
    }
  ],
  "dateSignedTabs": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "tabLabel": "sample string 3",
      "font": "sample string 4",
      "bold": "sample string 5",
      "italic": "sample string 6",
      "underline": "sample string 7",
      "fontColor": "sample string 8",
      "fontSize": "sample string 9",
      "documentId": "sample string 10",
      "recipientId": "sample string 11",
      "pageNumber": "sample string 12",
      "xPosition": "sample string 13",
      "yPosition": "sample string 14",
      "anchorString": "sample string 15",
      "anchorXOffset": "sample string 16",
      "anchorYOffset": "sample string 17",
      "anchorUnits": "sample string 18",
      "anchorIgnoreIfNotPresent": "sample string 19",
      "anchorCaseSensitive": "sample string 20",
      "anchorMatchWholeWord": "sample string 21",
      "anchorHorizontalAlignment": "sample string 22",
      "tabId": "sample string 23",
      "templateLocked": "sample string 24",
      "templateRequired": "sample string 25",
      "conditionalParentLabel": "sample string 26",
      "conditionalParentValue": "sample string 27",
      "customTabId": "sample string 28",
      "mergeField": {},
      "status": "sample string 29",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 30"
    }
  ],
  "envelopeIdTabs": [
    {
      "name": "sample string 1",
      "tabLabel": "sample string 2",
      "font": "sample string 3",
      "bold": "sample string 4",
      "italic": "sample string 5",
      "underline": "sample string 6",
      "fontColor": "sample string 7",
      "fontSize": "sample string 8",
      "documentId": "sample string 9",
      "recipientId": "sample string 10",
      "pageNumber": "sample string 11",
      "xPosition": "sample string 12",
      "yPosition": "sample string 13",
      "anchorString": "sample string 14",
      "anchorXOffset": "sample string 15",
      "anchorYOffset": "sample string 16",
      "anchorUnits": "sample string 17",
      "anchorIgnoreIfNotPresent": "sample string 18",
      "anchorCaseSensitive": "sample string 19",
      "anchorMatchWholeWord": "sample string 20",
      "anchorHorizontalAlignment": "sample string 21",
      "tabId": "sample string 22",
      "templateLocked": "sample string 23",
      "templateRequired": "sample string 24",
      "conditionalParentLabel": "sample string 25",
      "conditionalParentValue": "sample string 26",
      "customTabId": "sample string 27",
      "mergeField": {},
      "status": "sample string 28",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 29"
    }
  ],
  "companyTabs": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "originalValue": "sample string 3",
      "width": 4,
      "required": "sample string 5",
      "locked": "sample string 6",
      "concealValueOnDocument": "sample string 7",
      "disableAutoSize": "sample string 8",
      "maxLength": 9,
      "tabLabel": "sample string 10",
      "font": "sample string 11",
      "bold": "sample string 12",
      "italic": "sample string 13",
      "underline": "sample string 14",
      "fontColor": "sample string 15",
      "fontSize": "sample string 16",
      "documentId": "sample string 17",
      "recipientId": "sample string 18",
      "pageNumber": "sample string 19",
      "xPosition": "sample string 20",
      "yPosition": "sample string 21",
      "anchorString": "sample string 22",
      "anchorXOffset": "sample string 23",
      "anchorYOffset": "sample string 24",
      "anchorUnits": "sample string 25",
      "anchorIgnoreIfNotPresent": "sample string 26",
      "anchorCaseSensitive": "sample string 27",
      "anchorMatchWholeWord": "sample string 28",
      "anchorHorizontalAlignment": "sample string 29",
      "tabId": "sample string 30",
      "templateLocked": "sample string 31",
      "templateRequired": "sample string 32",
      "conditionalParentLabel": "sample string 33",
      "conditionalParentValue": "sample string 34",
      "customTabId": "sample string 35",
      "mergeField": {},
      "status": "sample string 36",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 37"
    }
  ],
  "titleTabs": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "originalValue": "sample string 3",
      "width": 4,
      "required": "sample string 5",
      "locked": "sample string 6",
      "concealValueOnDocument": "sample string 7",
      "disableAutoSize": "sample string 8",
      "maxLength": 9,
      "tabLabel": "sample string 10",
      "font": "sample string 11",
      "bold": "sample string 12",
      "italic": "sample string 13",
      "underline": "sample string 14",
      "fontColor": "sample string 15",
      "fontSize": "sample string 16",
      "documentId": "sample string 17",
      "recipientId": "sample string 18",
      "pageNumber": "sample string 19",
      "xPosition": "sample string 20",
      "yPosition": "sample string 21",
      "anchorString": "sample string 22",
      "anchorXOffset": "sample string 23",
      "anchorYOffset": "sample string 24",
      "anchorUnits": "sample string 25",
      "anchorIgnoreIfNotPresent": "sample string 26",
      "anchorCaseSensitive": "sample string 27",
      "anchorMatchWholeWord": "sample string 28",
      "anchorHorizontalAlignment": "sample string 29",
      "tabId": "sample string 30",
      "templateLocked": "sample string 31",
      "templateRequired": "sample string 32",
      "conditionalParentLabel": "sample string 33",
      "conditionalParentValue": "sample string 34",
      "customTabId": "sample string 35",
      "mergeField": {},
      "status": "sample string 36",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 37"
    }
  ],
  "textTabs": [
    {
      "height": 1,
      "isPaymentAmount": "sample string 2",
      "formula": "sample string 3",
      "validationPattern": "sample string 4",
      "validationMessage": "sample string 5",
      "shared": "sample string 6",
      "requireInitialOnSharedChange": "sample string 7",
      "senderRequired": "sample string 8",
      "requireAll": "sample string 9",
      "name": "sample string 10",
      "value": "sample string 11",
      "originalValue": "sample string 12",
      "width": 13,
      "required": "sample string 14",
      "locked": "sample string 15",
      "concealValueOnDocument": "sample string 16",
      "disableAutoSize": "sample string 17",
      "maxLength": 18,
      "tabLabel": "sample string 19",
      "font": "sample string 20",
      "bold": "sample string 21",
      "italic": "sample string 22",
      "underline": "sample string 23",
      "fontColor": "sample string 24",
      "fontSize": "sample string 25",
      "documentId": "sample string 26",
      "recipientId": "sample string 27",
      "pageNumber": "sample string 28",
      "xPosition": "sample string 29",
      "yPosition": "sample string 30",
      "anchorString": "sample string 31",
      "anchorXOffset": "sample string 32",
      "anchorYOffset": "sample string 33",
      "anchorUnits": "sample string 34",
      "anchorIgnoreIfNotPresent": "sample string 35",
      "anchorCaseSensitive": "sample string 36",
      "anchorMatchWholeWord": "sample string 37",
      "anchorHorizontalAlignment": "sample string 38",
      "tabId": "sample string 39",
      "templateLocked": "sample string 40",
      "templateRequired": "sample string 41",
      "conditionalParentLabel": "sample string 42",
      "conditionalParentValue": "sample string 43",
      "customTabId": "sample string 44",
      "mergeField": {},
      "status": "sample string 45",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 46"
    }
  ],
  "numberTabs": [
    {
      "isPaymentAmount": "sample string 1",
      "formula": "sample string 2",
      "validationPattern": "sample string 3",
      "validationMessage": "sample string 4",
      "shared": "sample string 5",
      "requireInitialOnSharedChange": "sample string 6",
      "senderRequired": "sample string 7",
      "requireAll": "sample string 8",
      "name": "sample string 9",
      "value": "sample string 10",
      "originalValue": "sample string 11",
      "width": 12,
      "required": "sample string 13",
      "locked": "sample string 14",
      "concealValueOnDocument": "sample string 15",
      "disableAutoSize": "sample string 16",
      "maxLength": 17,
      "tabLabel": "sample string 18",
      "font": "sample string 19",
      "bold": "sample string 20",
      "italic": "sample string 21",
      "underline": "sample string 22",
      "fontColor": "sample string 23",
      "fontSize": "sample string 24",
      "documentId": "sample string 25",
      "recipientId": "sample string 26",
      "pageNumber": "sample string 27",
      "xPosition": "sample string 28",
      "yPosition": "sample string 29",
      "anchorString": "sample string 30",
      "anchorXOffset": "sample string 31",
      "anchorYOffset": "sample string 32",
      "anchorUnits": "sample string 33",
      "anchorIgnoreIfNotPresent": "sample string 34",
      "anchorCaseSensitive": "sample string 35",
      "anchorMatchWholeWord": "sample string 36",
      "anchorHorizontalAlignment": "sample string 37",
      "tabId": "sample string 38",
      "templateLocked": "sample string 39",
      "templateRequired": "sample string 40",
      "conditionalParentLabel": "sample string 41",
      "conditionalParentValue": "sample string 42",
      "customTabId": "sample string 43",
      "mergeField": {},
      "status": "sample string 44",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 45"
    }
  ],
  "ssnTabs": [
    {
      "validationPattern": "sample string 1",
      "validationMessage": "sample string 2",
      "shared": "sample string 3",
      "requireInitialOnSharedChange": "sample string 4",
      "senderRequired": "sample string 5",
      "requireAll": "sample string 6",
      "name": "sample string 7",
      "value": "sample string 8",
      "originalValue": "sample string 9",
      "width": 10,
      "required": "sample string 11",
      "locked": "sample string 12",
      "concealValueOnDocument": "sample string 13",
      "disableAutoSize": "sample string 14",
      "maxLength": 15,
      "tabLabel": "sample string 16",
      "font": "sample string 17",
      "bold": "sample string 18",
      "italic": "sample string 19",
      "underline": "sample string 20",
      "fontColor": "sample string 21",
      "fontSize": "sample string 22",
      "documentId": "sample string 23",
      "recipientId": "sample string 24",
      "pageNumber": "sample string 25",
      "xPosition": "sample string 26",
      "yPosition": "sample string 27",
      "anchorString": "sample string 28",
      "anchorXOffset": "sample string 29",
      "anchorYOffset": "sample string 30",
      "anchorUnits": "sample string 31",
      "anchorIgnoreIfNotPresent": "sample string 32",
      "anchorCaseSensitive": "sample string 33",
      "anchorMatchWholeWord": "sample string 34",
      "anchorHorizontalAlignment": "sample string 35",
      "tabId": "sample string 36",
      "templateLocked": "sample string 37",
      "templateRequired": "sample string 38",
      "conditionalParentLabel": "sample string 39",
      "conditionalParentValue": "sample string 40",
      "customTabId": "sample string 41",
      "mergeField": {},
      "status": "sample string 42",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 43"
    }
  ],
  "dateTabs": [
    {
      "validationPattern": "sample string 1",
      "validationMessage": "sample string 2",
      "shared": "sample string 3",
      "requireInitialOnSharedChange": "sample string 4",
      "senderRequired": "sample string 5",
      "requireAll": "sample string 6",
      "name": "sample string 7",
      "value": "sample string 8",
      "originalValue": "sample string 9",
      "width": 10,
      "required": "sample string 11",
      "locked": "sample string 12",
      "concealValueOnDocument": "sample string 13",
      "disableAutoSize": "sample string 14",
      "maxLength": 15,
      "tabLabel": "sample string 16",
      "font": "sample string 17",
      "bold": "sample string 18",
      "italic": "sample string 19",
      "underline": "sample string 20",
      "fontColor": "sample string 21",
      "fontSize": "sample string 22",
      "documentId": "sample string 23",
      "recipientId": "sample string 24",
      "pageNumber": "sample string 25",
      "xPosition": "sample string 26",
      "yPosition": "sample string 27",
      "anchorString": "sample string 28",
      "anchorXOffset": "sample string 29",
      "anchorYOffset": "sample string 30",
      "anchorUnits": "sample string 31",
      "anchorIgnoreIfNotPresent": "sample string 32",
      "anchorCaseSensitive": "sample string 33",
      "anchorMatchWholeWord": "sample string 34",
      "anchorHorizontalAlignment": "sample string 35",
      "tabId": "sample string 36",
      "templateLocked": "sample string 37",
      "templateRequired": "sample string 38",
      "conditionalParentLabel": "sample string 39",
      "conditionalParentValue": "sample string 40",
      "customTabId": "sample string 41",
      "mergeField": {},
      "status": "sample string 42",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 43"
    }
  ],
  "zipTabs": [
    {
      "useDash4": "sample string 1",
      "validationPattern": "sample string 2",
      "validationMessage": "sample string 3",
      "shared": "sample string 4",
      "requireInitialOnSharedChange": "sample string 5",
      "senderRequired": "sample string 6",
      "requireAll": "sample string 7",
      "name": "sample string 8",
      "value": "sample string 9",
      "originalValue": "sample string 10",
      "width": 11,
      "required": "sample string 12",
      "locked": "sample string 13",
      "concealValueOnDocument": "sample string 14",
      "disableAutoSize": "sample string 15",
      "maxLength": 16,
      "tabLabel": "sample string 17",
      "font": "sample string 18",
      "bold": "sample string 19",
      "italic": "sample string 20",
      "underline": "sample string 21",
      "fontColor": "sample string 22",
      "fontSize": "sample string 23",
      "documentId": "sample string 24",
      "recipientId": "sample string 25",
      "pageNumber": "sample string 26",
      "xPosition": "sample string 27",
      "yPosition": "sample string 28",
      "anchorString": "sample string 29",
      "anchorXOffset": "sample string 30",
      "anchorYOffset": "sample string 31",
      "anchorUnits": "sample string 32",
      "anchorIgnoreIfNotPresent": "sample string 33",
      "anchorCaseSensitive": "sample string 34",
      "anchorMatchWholeWord": "sample string 35",
      "anchorHorizontalAlignment": "sample string 36",
      "tabId": "sample string 37",
      "templateLocked": "sample string 38",
      "templateRequired": "sample string 39",
      "conditionalParentLabel": "sample string 40",
      "conditionalParentValue": "sample string 41",
      "customTabId": "sample string 42",
      "mergeField": {},
      "status": "sample string 43",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 44"
    }
  ],
  "emailTabs": [
    {
      "validationPattern": "sample string 1",
      "validationMessage": "sample string 2",
      "shared": "sample string 3",
      "requireInitialOnSharedChange": "sample string 4",
      "senderRequired": "sample string 5",
      "requireAll": "sample string 6",
      "name": "sample string 7",
      "value": "sample string 8",
      "originalValue": "sample string 9",
      "width": 10,
      "required": "sample string 11",
      "locked": "sample string 12",
      "concealValueOnDocument": "sample string 13",
      "disableAutoSize": "sample string 14",
      "maxLength": 15,
      "tabLabel": "sample string 16",
      "font": "sample string 17",
      "bold": "sample string 18",
      "italic": "sample string 19",
      "underline": "sample string 20",
      "fontColor": "sample string 21",
      "fontSize": "sample string 22",
      "documentId": "sample string 23",
      "recipientId": "sample string 24",
      "pageNumber": "sample string 25",
      "xPosition": "sample string 26",
      "yPosition": "sample string 27",
      "anchorString": "sample string 28",
      "anchorXOffset": "sample string 29",
      "anchorYOffset": "sample string 30",
      "anchorUnits": "sample string 31",
      "anchorIgnoreIfNotPresent": "sample string 32",
      "anchorCaseSensitive": "sample string 33",
      "anchorMatchWholeWord": "sample string 34",
      "anchorHorizontalAlignment": "sample string 35",
      "tabId": "sample string 36",
      "templateLocked": "sample string 37",
      "templateRequired": "sample string 38",
      "conditionalParentLabel": "sample string 39",
      "conditionalParentValue": "sample string 40",
      "customTabId": "sample string 41",
      "mergeField": {},
      "status": "sample string 42",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 43"
    }
  ],
  "noteTabs": [
    {
      "width": 1,
      "height": 2,
      "shared": "sample string 3",
      "value": "sample string 4",
      "name": "sample string 5",
      "tabLabel": "sample string 6",
      "font": "sample string 7",
      "bold": "sample string 8",
      "italic": "sample string 9",
      "underline": "sample string 10",
      "fontColor": "sample string 11",
      "fontSize": "sample string 12",
      "documentId": "sample string 13",
      "recipientId": "sample string 14",
      "pageNumber": "sample string 15",
      "xPosition": "sample string 16",
      "yPosition": "sample string 17",
      "anchorString": "sample string 18",
      "anchorXOffset": "sample string 19",
      "anchorYOffset": "sample string 20",
      "anchorUnits": "sample string 21",
      "anchorIgnoreIfNotPresent": "sample string 22",
      "anchorCaseSensitive": "sample string 23",
      "anchorMatchWholeWord": "sample string 24",
      "anchorHorizontalAlignment": "sample string 25",
      "tabId": "sample string 26",
      "templateLocked": "sample string 27",
      "templateRequired": "sample string 28",
      "conditionalParentLabel": "sample string 29",
      "conditionalParentValue": "sample string 30",
      "customTabId": "sample string 31",
      "mergeField": {},
      "status": "sample string 32",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 33"
    }
  ],
  "checkboxTabs": [
    {
      "name": "sample string 1",
      "tabLabel": "sample string 2",
      "selected": "sample string 3",
      "shared": "sample string 4",
      "requireInitialOnSharedChange": "sample string 5",
      "required": "sample string 6",
      "locked": "sample string 7",
      "documentId": "sample string 8",
      "recipientId": "sample string 9",
      "pageNumber": "sample string 10",
      "xPosition": "sample string 11",
      "yPosition": "sample string 12",
      "anchorString": "sample string 13",
      "anchorXOffset": "sample string 14",
      "anchorYOffset": "sample string 15",
      "anchorUnits": "sample string 16",
      "anchorIgnoreIfNotPresent": "sample string 17",
      "anchorCaseSensitive": "sample string 18",
      "anchorMatchWholeWord": "sample string 19",
      "anchorHorizontalAlignment": "sample string 20",
      "tabId": "sample string 21",
      "templateLocked": "sample string 22",
      "templateRequired": "sample string 23",
      "conditionalParentLabel": "sample string 24",
      "conditionalParentValue": "sample string 25",
      "customTabId": "sample string 26",
      "mergeField": {},
      "status": "sample string 27",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 28"
    }
  ],
  "radioGroupTabs": [
    {
      "documentId": "sample string 1",
      "recipientId": "sample string 2",
      "templateLocked": "sample string 3",
      "templateRequired": "sample string 4",
      "conditionalParentLabel": "sample string 5",
      "conditionalParentValue": "sample string 6",
      "groupName": "sample string 7",
      "radios": [
        {
          "pageNumber": "sample string 1",
          "xPosition": "sample string 2",
          "yPosition": "sample string 3",
          "anchorString": "sample string 4",
          "anchorXOffset": "sample string 5",
          "anchorYOffset": "sample string 6",
          "anchorUnits": "sample string 7",
          "anchorIgnoreIfNotPresent": "sample string 8",
          "anchorCaseSensitive": "sample string 9",
          "anchorMatchWholeWord": "sample string 10",
          "anchorHorizontalAlignment": "sample string 11",
          "value": "sample string 12",
          "selected": "sample string 13",
          "tabId": "sample string 14",
          "required": "sample string 15",
          "locked": "sample string 16",
          "errorDetails": {
            "errorCode": "SUCCESS",
            "message": ""
          },
          "tabOrder": "sample string 17"
        }
      ],
      "shared": "sample string 8",
      "requireInitialOnSharedChange": "sample string 9",
      "requireAll": "sample string 10"
    }
  ],
  "listTabs": [
    {
      "listItems": [
        {
          "text": "sample string 1",
          "value": "sample string 2",
          "selected": "sample string 3"
        }
      ],
      "value": "sample string 1",
      "width": 2,
      "shared": "sample string 3",
      "requireInitialOnSharedChange": "sample string 4",
      "required": "sample string 5",
      "locked": "sample string 6",
      "senderRequired": "sample string 7",
      "requireAll": "sample string 8",
      "tabLabel": "sample string 9",
      "font": "sample string 10",
      "bold": "sample string 11",
      "italic": "sample string 12",
      "underline": "sample string 13",
      "fontColor": "sample string 14",
      "fontSize": "sample string 15",
      "documentId": "sample string 16",
      "recipientId": "sample string 17",
      "pageNumber": "sample string 18",
      "xPosition": "sample string 19",
      "yPosition": "sample string 20",
      "anchorString": "sample string 21",
      "anchorXOffset": "sample string 22",
      "anchorYOffset": "sample string 23",
      "anchorUnits": "sample string 24",
      "anchorIgnoreIfNotPresent": "sample string 25",
      "anchorCaseSensitive": "sample string 26",
      "anchorMatchWholeWord": "sample string 27",
      "anchorHorizontalAlignment": "sample string 28",
      "tabId": "sample string 29",
      "templateLocked": "sample string 30",
      "templateRequired": "sample string 31",
      "conditionalParentLabel": "sample string 32",
      "conditionalParentValue": "sample string 33",
      "customTabId": "sample string 34",
      "mergeField": {},
      "status": "sample string 35",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 36"
    }
  ],
  "firstNameTabs": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "tabLabel": "sample string 3",
      "font": "sample string 4",
      "bold": "sample string 5",
      "italic": "sample string 6",
      "underline": "sample string 7",
      "fontColor": "sample string 8",
      "fontSize": "sample string 9",
      "documentId": "sample string 10",
      "recipientId": "sample string 11",
      "pageNumber": "sample string 12",
      "xPosition": "sample string 13",
      "yPosition": "sample string 14",
      "anchorString": "sample string 15",
      "anchorXOffset": "sample string 16",
      "anchorYOffset": "sample string 17",
      "anchorUnits": "sample string 18",
      "anchorIgnoreIfNotPresent": "sample string 19",
      "anchorCaseSensitive": "sample string 20",
      "anchorMatchWholeWord": "sample string 21",
      "anchorHorizontalAlignment": "sample string 22",
      "tabId": "sample string 23",
      "templateLocked": "sample string 24",
      "templateRequired": "sample string 25",
      "conditionalParentLabel": "sample string 26",
      "conditionalParentValue": "sample string 27",
      "customTabId": "sample string 28",
      "mergeField": {},
      "status": "sample string 29",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 30"
    }
  ],
  "lastNameTabs": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "tabLabel": "sample string 3",
      "font": "sample string 4",
      "bold": "sample string 5",
      "italic": "sample string 6",
      "underline": "sample string 7",
      "fontColor": "sample string 8",
      "fontSize": "sample string 9",
      "documentId": "sample string 10",
      "recipientId": "sample string 11",
      "pageNumber": "sample string 12",
      "xPosition": "sample string 13",
      "yPosition": "sample string 14",
      "anchorString": "sample string 15",
      "anchorXOffset": "sample string 16",
      "anchorYOffset": "sample string 17",
      "anchorUnits": "sample string 18",
      "anchorIgnoreIfNotPresent": "sample string 19",
      "anchorCaseSensitive": "sample string 20",
      "anchorMatchWholeWord": "sample string 21",
      "anchorHorizontalAlignment": "sample string 22",
      "tabId": "sample string 23",
      "templateLocked": "sample string 24",
      "templateRequired": "sample string 25",
      "conditionalParentLabel": "sample string 26",
      "conditionalParentValue": "sample string 27",
      "customTabId": "sample string 28",
      "mergeField": {},
      "status": "sample string 29",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 30"
    }
  ],
  "emailAddressTabs": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "tabLabel": "sample string 3",
      "font": "sample string 4",
      "bold": "sample string 5",
      "italic": "sample string 6",
      "underline": "sample string 7",
      "fontColor": "sample string 8",
      "fontSize": "sample string 9",
      "documentId": "sample string 10",
      "recipientId": "sample string 11",
      "pageNumber": "sample string 12",
      "xPosition": "sample string 13",
      "yPosition": "sample string 14",
      "anchorString": "sample string 15",
      "anchorXOffset": "sample string 16",
      "anchorYOffset": "sample string 17",
      "anchorUnits": "sample string 18",
      "anchorIgnoreIfNotPresent": "sample string 19",
      "anchorCaseSensitive": "sample string 20",
      "anchorMatchWholeWord": "sample string 21",
      "anchorHorizontalAlignment": "sample string 22",
      "tabId": "sample string 23",
      "templateLocked": "sample string 24",
      "templateRequired": "sample string 25",
      "conditionalParentLabel": "sample string 26",
      "conditionalParentValue": "sample string 27",
      "customTabId": "sample string 28",
      "mergeField": {},
      "status": "sample string 29",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 30"
    }
  ],
  "formulaTabs": [
    {
      "isPaymentAmount": "sample string 1",
      "formula": "sample string 2",
      "roundDecimalPlaces": "sample string 3",
      "paymentDetails": {
        "total": {
          "amountInBaseUnit": "sample string 1",
          "currency": "sample string 2",
          "displayAmount": "sample string 3"
        },
        "status": "sample string 1",
        "currencyCode": "sample string 2",
        "lineItems": [
          {
            "name": "sample string 1",
            "description": "sample string 2",
            "itemCode": "sample string 3",
            "amountReference": "sample string 4"
          }
        ],
        "allowedPaymentMethods": [
          "sample string 1"
        ],
        "gatewayAccountId": "sample string 3",
        "gatewayName": "sample string 4",
        "gatewayDisplayName": "sample string 5",
        "chargeId": "sample string 6"
      },
      "hidden": "sample string 4",
      "validationPattern": "sample string 5",
      "validationMessage": "sample string 6",
      "shared": "sample string 7",
      "requireInitialOnSharedChange": "sample string 8",
      "senderRequired": "sample string 9",
      "requireAll": "sample string 10",
      "name": "sample string 11",
      "value": "sample string 12",
      "originalValue": "sample string 13",
      "width": 14,
      "required": "sample string 15",
      "locked": "sample string 16",
      "concealValueOnDocument": "sample string 17",
      "disableAutoSize": "sample string 18",
      "maxLength": 19,
      "tabLabel": "sample string 20",
      "font": "sample string 21",
      "bold": "sample string 22",
      "italic": "sample string 23",
      "underline": "sample string 24",
      "fontColor": "sample string 25",
      "fontSize": "sample string 26",
      "documentId": "sample string 27",
      "recipientId": "sample string 28",
      "pageNumber": "sample string 29",
      "xPosition": "sample string 30",
      "yPosition": "sample string 31",
      "anchorString": "sample string 32",
      "anchorXOffset": "sample string 33",
      "anchorYOffset": "sample string 34",
      "anchorUnits": "sample string 35",
      "anchorIgnoreIfNotPresent": "sample string 36",
      "anchorCaseSensitive": "sample string 37",
      "anchorMatchWholeWord": "sample string 38",
      "anchorHorizontalAlignment": "sample string 39",
      "tabId": "sample string 40",
      "templateLocked": "sample string 41",
      "templateRequired": "sample string 42",
      "conditionalParentLabel": "sample string 43",
      "conditionalParentValue": "sample string 44",
      "customTabId": "sample string 45",
      "mergeField": {},
      "status": "sample string 46",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 47"
    }
  ],
  "notarizeTabs": [
    {
      "required": "sample string 1",
      "locked": "sample string 2",
      "documentId": "sample string 3",
      "recipientId": "sample string 4",
      "pageNumber": "sample string 5",
      "xPosition": "sample string 6",
      "yPosition": "sample string 7",
      "anchorString": "sample string 8",
      "anchorXOffset": "sample string 9",
      "anchorYOffset": "sample string 10",
      "anchorUnits": "sample string 11",
      "anchorIgnoreIfNotPresent": "sample string 12",
      "anchorCaseSensitive": "sample string 13",
      "anchorMatchWholeWord": "sample string 14",
      "anchorHorizontalAlignment": "sample string 15",
      "tabId": "sample string 16",
      "templateLocked": "sample string 17",
      "templateRequired": "sample string 18",
      "conditionalParentLabel": "sample string 19",
      "conditionalParentValue": "sample string 20",
      "customTabId": "sample string 21",
      "mergeField": {},
      "status": "sample string 22",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "tabOrder": "sample string 23"
    }
  ]
}
Generic XML Response

Response
<tabs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <approveTabs>
    <approve>
      <anchorCaseSensitive>sample string 21</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 23</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 20</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 22</anchorMatchWholeWord>
      <anchorString>sample string 16</anchorString>
      <anchorUnits>sample string 19</anchorUnits>
      <anchorXOffset>sample string 17</anchorXOffset>
      <anchorYOffset>sample string 18</anchorYOffset>
      <conditionalParentLabel>sample string 27</conditionalParentLabel>
      <conditionalParentValue>sample string 28</conditionalParentValue>
      <customTabId>sample string 29</customTabId>
      <documentId>sample string 11</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 13</pageNumber>
      <recipientId>sample string 12</recipientId>
      <status>sample string 30</status>
      <tabId>sample string 24</tabId>
      <tabOrder>sample string 31</tabOrder>
      <templateLocked>sample string 25</templateLocked>
      <templateRequired>sample string 26</templateRequired>
      <xPosition>sample string 14</xPosition>
      <yPosition>sample string 15</yPosition>
      <bold>sample string 6</bold>
      <font>sample string 5</font>
      <fontColor>sample string 9</fontColor>
      <fontSize>sample string 10</fontSize>
      <italic>sample string 7</italic>
      <tabLabel>sample string 4</tabLabel>
      <underline>sample string 8</underline>
      <buttonText>sample string 1</buttonText>
      <height>3</height>
      <width>2</width>
    </approve>
  </approveTabs>
  <checkboxTabs>
    <checkbox>
      <anchorCaseSensitive>sample string 18</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 20</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 17</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 19</anchorMatchWholeWord>
      <anchorString>sample string 13</anchorString>
      <anchorUnits>sample string 16</anchorUnits>
      <anchorXOffset>sample string 14</anchorXOffset>
      <anchorYOffset>sample string 15</anchorYOffset>
      <conditionalParentLabel>sample string 24</conditionalParentLabel>
      <conditionalParentValue>sample string 25</conditionalParentValue>
      <customTabId>sample string 26</customTabId>
      <documentId>sample string 8</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 10</pageNumber>
      <recipientId>sample string 9</recipientId>
      <status>sample string 27</status>
      <tabId>sample string 21</tabId>
      <tabOrder>sample string 28</tabOrder>
      <templateLocked>sample string 22</templateLocked>
      <templateRequired>sample string 23</templateRequired>
      <xPosition>sample string 11</xPosition>
      <yPosition>sample string 12</yPosition>
      <locked>sample string 7</locked>
      <required>sample string 6</required>
      <name>sample string 1</name>
      <requireInitialOnSharedChange>sample string 5</requireInitialOnSharedChange>
      <selected>sample string 3</selected>
      <shared>sample string 4</shared>
      <tabLabel>sample string 2</tabLabel>
    </checkbox>
  </checkboxTabs>
  <companyTabs>
    <company>
      <anchorCaseSensitive>sample string 27</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 29</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 26</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 28</anchorMatchWholeWord>
      <anchorString>sample string 22</anchorString>
      <anchorUnits>sample string 25</anchorUnits>
      <anchorXOffset>sample string 23</anchorXOffset>
      <anchorYOffset>sample string 24</anchorYOffset>
      <conditionalParentLabel>sample string 33</conditionalParentLabel>
      <conditionalParentValue>sample string 34</conditionalParentValue>
      <customTabId>sample string 35</customTabId>
      <documentId>sample string 17</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 19</pageNumber>
      <recipientId>sample string 18</recipientId>
      <status>sample string 36</status>
      <tabId>sample string 30</tabId>
      <tabOrder>sample string 37</tabOrder>
      <templateLocked>sample string 31</templateLocked>
      <templateRequired>sample string 32</templateRequired>
      <xPosition>sample string 20</xPosition>
      <yPosition>sample string 21</yPosition>
      <bold>sample string 12</bold>
      <font>sample string 11</font>
      <fontColor>sample string 15</fontColor>
      <fontSize>sample string 16</fontSize>
      <italic>sample string 13</italic>
      <tabLabel>sample string 10</tabLabel>
      <underline>sample string 14</underline>
      <concealValueOnDocument>sample string 7</concealValueOnDocument>
      <disableAutoSize>sample string 8</disableAutoSize>
      <locked>sample string 6</locked>
      <maxLength>9</maxLength>
      <name>sample string 1</name>
      <originalValue>sample string 3</originalValue>
      <required>sample string 5</required>
      <value>sample string 2</value>
      <width>4</width>
    </company>
  </companyTabs>
  <dateSignedTabs>
    <dateSigned>
      <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
      <anchorString>sample string 15</anchorString>
      <anchorUnits>sample string 18</anchorUnits>
      <anchorXOffset>sample string 16</anchorXOffset>
      <anchorYOffset>sample string 17</anchorYOffset>
      <conditionalParentLabel>sample string 26</conditionalParentLabel>
      <conditionalParentValue>sample string 27</conditionalParentValue>
      <customTabId>sample string 28</customTabId>
      <documentId>sample string 10</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 12</pageNumber>
      <recipientId>sample string 11</recipientId>
      <status>sample string 29</status>
      <tabId>sample string 23</tabId>
      <tabOrder>sample string 30</tabOrder>
      <templateLocked>sample string 24</templateLocked>
      <templateRequired>sample string 25</templateRequired>
      <xPosition>sample string 13</xPosition>
      <yPosition>sample string 14</yPosition>
      <bold>sample string 5</bold>
      <font>sample string 4</font>
      <fontColor>sample string 8</fontColor>
      <fontSize>sample string 9</fontSize>
      <italic>sample string 6</italic>
      <tabLabel>sample string 3</tabLabel>
      <underline>sample string 7</underline>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </dateSigned>
  </dateSignedTabs>
  <dateTabs>
    <date>
      <anchorCaseSensitive>sample string 33</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 35</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 32</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 34</anchorMatchWholeWord>
      <anchorString>sample string 28</anchorString>
      <anchorUnits>sample string 31</anchorUnits>
      <anchorXOffset>sample string 29</anchorXOffset>
      <anchorYOffset>sample string 30</anchorYOffset>
      <conditionalParentLabel>sample string 39</conditionalParentLabel>
      <conditionalParentValue>sample string 40</conditionalParentValue>
      <customTabId>sample string 41</customTabId>
      <documentId>sample string 23</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 25</pageNumber>
      <recipientId>sample string 24</recipientId>
      <status>sample string 42</status>
      <tabId>sample string 36</tabId>
      <tabOrder>sample string 43</tabOrder>
      <templateLocked>sample string 37</templateLocked>
      <templateRequired>sample string 38</templateRequired>
      <xPosition>sample string 26</xPosition>
      <yPosition>sample string 27</yPosition>
      <bold>sample string 18</bold>
      <font>sample string 17</font>
      <fontColor>sample string 21</fontColor>
      <fontSize>sample string 22</fontSize>
      <italic>sample string 19</italic>
      <tabLabel>sample string 16</tabLabel>
      <underline>sample string 20</underline>
      <concealValueOnDocument>sample string 13</concealValueOnDocument>
      <disableAutoSize>sample string 14</disableAutoSize>
      <locked>sample string 12</locked>
      <maxLength>15</maxLength>
      <name>sample string 7</name>
      <originalValue>sample string 9</originalValue>
      <required>sample string 11</required>
      <value>sample string 8</value>
      <width>10</width>
      <requireAll>sample string 6</requireAll>
      <requireInitialOnSharedChange>sample string 4</requireInitialOnSharedChange>
      <senderRequired>sample string 5</senderRequired>
      <shared>sample string 3</shared>
      <validationMessage>sample string 2</validationMessage>
      <validationPattern>sample string 1</validationPattern>
    </date>
  </dateTabs>
  <declineTabs>
    <decline>
      <anchorCaseSensitive>sample string 22</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 24</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 21</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 23</anchorMatchWholeWord>
      <anchorString>sample string 17</anchorString>
      <anchorUnits>sample string 20</anchorUnits>
      <anchorXOffset>sample string 18</anchorXOffset>
      <anchorYOffset>sample string 19</anchorYOffset>
      <conditionalParentLabel>sample string 28</conditionalParentLabel>
      <conditionalParentValue>sample string 29</conditionalParentValue>
      <customTabId>sample string 30</customTabId>
      <documentId>sample string 12</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 14</pageNumber>
      <recipientId>sample string 13</recipientId>
      <status>sample string 31</status>
      <tabId>sample string 25</tabId>
      <tabOrder>sample string 32</tabOrder>
      <templateLocked>sample string 26</templateLocked>
      <templateRequired>sample string 27</templateRequired>
      <xPosition>sample string 15</xPosition>
      <yPosition>sample string 16</yPosition>
      <bold>sample string 7</bold>
      <font>sample string 6</font>
      <fontColor>sample string 10</fontColor>
      <fontSize>sample string 11</fontSize>
      <italic>sample string 8</italic>
      <tabLabel>sample string 5</tabLabel>
      <underline>sample string 9</underline>
      <buttonText>sample string 1</buttonText>
      <declineReason>sample string 4</declineReason>
      <height>3</height>
      <width>2</width>
    </decline>
  </declineTabs>
  <emailAddressTabs>
    <emailAddress>
      <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
      <anchorString>sample string 15</anchorString>
      <anchorUnits>sample string 18</anchorUnits>
      <anchorXOffset>sample string 16</anchorXOffset>
      <anchorYOffset>sample string 17</anchorYOffset>
      <conditionalParentLabel>sample string 26</conditionalParentLabel>
      <conditionalParentValue>sample string 27</conditionalParentValue>
      <customTabId>sample string 28</customTabId>
      <documentId>sample string 10</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 12</pageNumber>
      <recipientId>sample string 11</recipientId>
      <status>sample string 29</status>
      <tabId>sample string 23</tabId>
      <tabOrder>sample string 30</tabOrder>
      <templateLocked>sample string 24</templateLocked>
      <templateRequired>sample string 25</templateRequired>
      <xPosition>sample string 13</xPosition>
      <yPosition>sample string 14</yPosition>
      <bold>sample string 5</bold>
      <font>sample string 4</font>
      <fontColor>sample string 8</fontColor>
      <fontSize>sample string 9</fontSize>
      <italic>sample string 6</italic>
      <tabLabel>sample string 3</tabLabel>
      <underline>sample string 7</underline>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </emailAddress>
  </emailAddressTabs>
  <emailTabs>
    <email>
      <anchorCaseSensitive>sample string 33</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 35</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 32</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 34</anchorMatchWholeWord>
      <anchorString>sample string 28</anchorString>
      <anchorUnits>sample string 31</anchorUnits>
      <anchorXOffset>sample string 29</anchorXOffset>
      <anchorYOffset>sample string 30</anchorYOffset>
      <conditionalParentLabel>sample string 39</conditionalParentLabel>
      <conditionalParentValue>sample string 40</conditionalParentValue>
      <customTabId>sample string 41</customTabId>
      <documentId>sample string 23</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 25</pageNumber>
      <recipientId>sample string 24</recipientId>
      <status>sample string 42</status>
      <tabId>sample string 36</tabId>
      <tabOrder>sample string 43</tabOrder>
      <templateLocked>sample string 37</templateLocked>
      <templateRequired>sample string 38</templateRequired>
      <xPosition>sample string 26</xPosition>
      <yPosition>sample string 27</yPosition>
      <bold>sample string 18</bold>
      <font>sample string 17</font>
      <fontColor>sample string 21</fontColor>
      <fontSize>sample string 22</fontSize>
      <italic>sample string 19</italic>
      <tabLabel>sample string 16</tabLabel>
      <underline>sample string 20</underline>
      <concealValueOnDocument>sample string 13</concealValueOnDocument>
      <disableAutoSize>sample string 14</disableAutoSize>
      <locked>sample string 12</locked>
      <maxLength>15</maxLength>
      <name>sample string 7</name>
      <originalValue>sample string 9</originalValue>
      <required>sample string 11</required>
      <value>sample string 8</value>
      <width>10</width>
      <requireAll>sample string 6</requireAll>
      <requireInitialOnSharedChange>sample string 4</requireInitialOnSharedChange>
      <senderRequired>sample string 5</senderRequired>
      <shared>sample string 3</shared>
      <validationMessage>sample string 2</validationMessage>
      <validationPattern>sample string 1</validationPattern>
    </email>
  </emailTabs>
  <envelopeIdTabs>
    <envelopeId>
      <anchorCaseSensitive>sample string 19</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 21</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 18</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 20</anchorMatchWholeWord>
      <anchorString>sample string 14</anchorString>
      <anchorUnits>sample string 17</anchorUnits>
      <anchorXOffset>sample string 15</anchorXOffset>
      <anchorYOffset>sample string 16</anchorYOffset>
      <conditionalParentLabel>sample string 25</conditionalParentLabel>
      <conditionalParentValue>sample string 26</conditionalParentValue>
      <customTabId>sample string 27</customTabId>
      <documentId>sample string 9</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 11</pageNumber>
      <recipientId>sample string 10</recipientId>
      <status>sample string 28</status>
      <tabId>sample string 22</tabId>
      <tabOrder>sample string 29</tabOrder>
      <templateLocked>sample string 23</templateLocked>
      <templateRequired>sample string 24</templateRequired>
      <xPosition>sample string 12</xPosition>
      <yPosition>sample string 13</yPosition>
      <bold>sample string 4</bold>
      <font>sample string 3</font>
      <fontColor>sample string 7</fontColor>
      <fontSize>sample string 8</fontSize>
      <italic>sample string 5</italic>
      <tabLabel>sample string 2</tabLabel>
      <underline>sample string 6</underline>
      <name>sample string 1</name>
    </envelopeId>
  </envelopeIdTabs>
  <firstNameTabs>
    <firstName>
      <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
      <anchorString>sample string 15</anchorString>
      <anchorUnits>sample string 18</anchorUnits>
      <anchorXOffset>sample string 16</anchorXOffset>
      <anchorYOffset>sample string 17</anchorYOffset>
      <conditionalParentLabel>sample string 26</conditionalParentLabel>
      <conditionalParentValue>sample string 27</conditionalParentValue>
      <customTabId>sample string 28</customTabId>
      <documentId>sample string 10</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 12</pageNumber>
      <recipientId>sample string 11</recipientId>
      <status>sample string 29</status>
      <tabId>sample string 23</tabId>
      <tabOrder>sample string 30</tabOrder>
      <templateLocked>sample string 24</templateLocked>
      <templateRequired>sample string 25</templateRequired>
      <xPosition>sample string 13</xPosition>
      <yPosition>sample string 14</yPosition>
      <bold>sample string 5</bold>
      <font>sample string 4</font>
      <fontColor>sample string 8</fontColor>
      <fontSize>sample string 9</fontSize>
      <italic>sample string 6</italic>
      <tabLabel>sample string 3</tabLabel>
      <underline>sample string 7</underline>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </firstName>
  </firstNameTabs>
  <formulaTabs xmlns:d2p1="http://schemas.datacontract.org/2004/07/API_REST.Models">
    <d2p1:formulaTab>
      <anchorCaseSensitive>sample string 37</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 39</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 36</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 38</anchorMatchWholeWord>
      <anchorString>sample string 32</anchorString>
      <anchorUnits>sample string 35</anchorUnits>
      <anchorXOffset>sample string 33</anchorXOffset>
      <anchorYOffset>sample string 34</anchorYOffset>
      <conditionalParentLabel>sample string 43</conditionalParentLabel>
      <conditionalParentValue>sample string 44</conditionalParentValue>
      <customTabId>sample string 45</customTabId>
      <documentId>sample string 27</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 29</pageNumber>
      <recipientId>sample string 28</recipientId>
      <status>sample string 46</status>
      <tabId>sample string 40</tabId>
      <tabOrder>sample string 47</tabOrder>
      <templateLocked>sample string 41</templateLocked>
      <templateRequired>sample string 42</templateRequired>
      <xPosition>sample string 30</xPosition>
      <yPosition>sample string 31</yPosition>
      <bold>sample string 22</bold>
      <font>sample string 21</font>
      <fontColor>sample string 25</fontColor>
      <fontSize>sample string 26</fontSize>
      <italic>sample string 23</italic>
      <tabLabel>sample string 20</tabLabel>
      <underline>sample string 24</underline>
      <concealValueOnDocument>sample string 17</concealValueOnDocument>
      <disableAutoSize>sample string 18</disableAutoSize>
      <locked>sample string 16</locked>
      <maxLength>19</maxLength>
      <name>sample string 11</name>
      <originalValue>sample string 13</originalValue>
      <required>sample string 15</required>
      <value>sample string 12</value>
      <width>14</width>
      <requireAll>sample string 10</requireAll>
      <requireInitialOnSharedChange>sample string 8</requireInitialOnSharedChange>
      <senderRequired>sample string 9</senderRequired>
      <shared>sample string 7</shared>
      <validationMessage>sample string 6</validationMessage>
      <validationPattern>sample string 5</validationPattern>
      <d2p1:formula>sample string 2</d2p1:formula>
      <d2p1:hidden>sample string 4</d2p1:hidden>
      <d2p1:isPaymentAmount>sample string 1</d2p1:isPaymentAmount>
      <d2p1:paymentDetails>
        <allowedPaymentMethods xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
        </allowedPaymentMethods>
        <chargeId>sample string 6</chargeId>
        <currencyCode>sample string 2</currencyCode>
        <gatewayAccountId>sample string 3</gatewayAccountId>
        <gatewayDisplayName>sample string 5</gatewayDisplayName>
        <gatewayName>sample string 4</gatewayName>
        <lineItems xmlns:d5p1="http://schemas.datacontract.org/2004/07/API_REST.Models.v2.payments">
          <d5p1:paymentLineItem>
            <d5p1:amountReference>sample string 4</d5p1:amountReference>
            <d5p1:description>sample string 2</d5p1:description>
            <d5p1:itemCode>sample string 3</d5p1:itemCode>
            <d5p1:name>sample string 1</d5p1:name>
          </d5p1:paymentLineItem>
        </lineItems>
        <status>sample string 1</status>
        <total>
          <amountInBaseUnit>sample string 1</amountInBaseUnit>
          <currency>sample string 2</currency>
          <displayAmount>sample string 3</displayAmount>
        </total>
      </d2p1:paymentDetails>
      <d2p1:roundDecimalPlaces>sample string 3</d2p1:roundDecimalPlaces>
    </d2p1:formulaTab>
  </formulaTabs>
  <fullNameTabs>
    <fullName>
      <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
      <anchorString>sample string 15</anchorString>
      <anchorUnits>sample string 18</anchorUnits>
      <anchorXOffset>sample string 16</anchorXOffset>
      <anchorYOffset>sample string 17</anchorYOffset>
      <conditionalParentLabel>sample string 26</conditionalParentLabel>
      <conditionalParentValue>sample string 27</conditionalParentValue>
      <customTabId>sample string 28</customTabId>
      <documentId>sample string 10</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 12</pageNumber>
      <recipientId>sample string 11</recipientId>
      <status>sample string 29</status>
      <tabId>sample string 23</tabId>
      <tabOrder>sample string 30</tabOrder>
      <templateLocked>sample string 24</templateLocked>
      <templateRequired>sample string 25</templateRequired>
      <xPosition>sample string 13</xPosition>
      <yPosition>sample string 14</yPosition>
      <bold>sample string 5</bold>
      <font>sample string 4</font>
      <fontColor>sample string 8</fontColor>
      <fontSize>sample string 9</fontSize>
      <italic>sample string 6</italic>
      <tabLabel>sample string 3</tabLabel>
      <underline>sample string 7</underline>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </fullName>
  </fullNameTabs>
  <initialHereTabs>
    <initialHere>
      <anchorCaseSensitive>sample string 14</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 16</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 13</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 15</anchorMatchWholeWord>
      <anchorString>sample string 9</anchorString>
      <anchorUnits>sample string 12</anchorUnits>
      <anchorXOffset>sample string 10</anchorXOffset>
      <anchorYOffset>sample string 11</anchorYOffset>
      <conditionalParentLabel>sample string 20</conditionalParentLabel>
      <conditionalParentValue>sample string 21</conditionalParentValue>
      <customTabId>sample string 22</customTabId>
      <documentId>sample string 4</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 6</pageNumber>
      <recipientId>sample string 5</recipientId>
      <status>sample string 23</status>
      <tabId>sample string 17</tabId>
      <tabOrder>sample string 24</tabOrder>
      <templateLocked>sample string 18</templateLocked>
      <templateRequired>sample string 19</templateRequired>
      <xPosition>sample string 7</xPosition>
      <yPosition>sample string 8</yPosition>
      <name>sample string 1</name>
      <optional>sample string 3</optional>
      <scaleValue>1.1</scaleValue>
      <tabLabel>sample string 2</tabLabel>
    </initialHere>
  </initialHereTabs>
  <lastNameTabs>
    <lastName>
      <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
      <anchorString>sample string 15</anchorString>
      <anchorUnits>sample string 18</anchorUnits>
      <anchorXOffset>sample string 16</anchorXOffset>
      <anchorYOffset>sample string 17</anchorYOffset>
      <conditionalParentLabel>sample string 26</conditionalParentLabel>
      <conditionalParentValue>sample string 27</conditionalParentValue>
      <customTabId>sample string 28</customTabId>
      <documentId>sample string 10</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 12</pageNumber>
      <recipientId>sample string 11</recipientId>
      <status>sample string 29</status>
      <tabId>sample string 23</tabId>
      <tabOrder>sample string 30</tabOrder>
      <templateLocked>sample string 24</templateLocked>
      <templateRequired>sample string 25</templateRequired>
      <xPosition>sample string 13</xPosition>
      <yPosition>sample string 14</yPosition>
      <bold>sample string 5</bold>
      <font>sample string 4</font>
      <fontColor>sample string 8</fontColor>
      <fontSize>sample string 9</fontSize>
      <italic>sample string 6</italic>
      <tabLabel>sample string 3</tabLabel>
      <underline>sample string 7</underline>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </lastName>
  </lastNameTabs>
  <listTabs>
    <list>
      <anchorCaseSensitive>sample string 26</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 28</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 25</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 27</anchorMatchWholeWord>
      <anchorString>sample string 21</anchorString>
      <anchorUnits>sample string 24</anchorUnits>
      <anchorXOffset>sample string 22</anchorXOffset>
      <anchorYOffset>sample string 23</anchorYOffset>
      <conditionalParentLabel>sample string 32</conditionalParentLabel>
      <conditionalParentValue>sample string 33</conditionalParentValue>
      <customTabId>sample string 34</customTabId>
      <documentId>sample string 16</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 18</pageNumber>
      <recipientId>sample string 17</recipientId>
      <status>sample string 35</status>
      <tabId>sample string 29</tabId>
      <tabOrder>sample string 36</tabOrder>
      <templateLocked>sample string 30</templateLocked>
      <templateRequired>sample string 31</templateRequired>
      <xPosition>sample string 19</xPosition>
      <yPosition>sample string 20</yPosition>
      <bold>sample string 11</bold>
      <font>sample string 10</font>
      <fontColor>sample string 14</fontColor>
      <fontSize>sample string 15</fontSize>
      <italic>sample string 12</italic>
      <tabLabel>sample string 9</tabLabel>
      <underline>sample string 13</underline>
      <listItems>
        <listItem>
          <selected>sample string 3</selected>
          <text>sample string 1</text>
          <value>sample string 2</value>
        </listItem>
      </listItems>
      <locked>sample string 6</locked>
      <requireAll>sample string 8</requireAll>
      <requireInitialOnSharedChange>sample string 4</requireInitialOnSharedChange>
      <required>sample string 5</required>
      <senderRequired>sample string 7</senderRequired>
      <shared>sample string 3</shared>
      <value>sample string 1</value>
      <width>2</width>
    </list>
  </listTabs>
  <notarizeTabs>
    <notarize>
      <anchorCaseSensitive>sample string 13</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 15</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 12</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 14</anchorMatchWholeWord>
      <anchorString>sample string 8</anchorString>
      <anchorUnits>sample string 11</anchorUnits>
      <anchorXOffset>sample string 9</anchorXOffset>
      <anchorYOffset>sample string 10</anchorYOffset>
      <conditionalParentLabel>sample string 19</conditionalParentLabel>
      <conditionalParentValue>sample string 20</conditionalParentValue>
      <customTabId>sample string 21</customTabId>
      <documentId>sample string 3</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 5</pageNumber>
      <recipientId>sample string 4</recipientId>
      <status>sample string 22</status>
      <tabId>sample string 16</tabId>
      <tabOrder>sample string 23</tabOrder>
      <templateLocked>sample string 17</templateLocked>
      <templateRequired>sample string 18</templateRequired>
      <xPosition>sample string 6</xPosition>
      <yPosition>sample string 7</yPosition>
      <locked>sample string 2</locked>
      <required>sample string 1</required>
    </notarize>
  </notarizeTabs>
  <noteTabs>
    <note>
      <anchorCaseSensitive>sample string 23</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 25</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 22</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 24</anchorMatchWholeWord>
      <anchorString>sample string 18</anchorString>
      <anchorUnits>sample string 21</anchorUnits>
      <anchorXOffset>sample string 19</anchorXOffset>
      <anchorYOffset>sample string 20</anchorYOffset>
      <conditionalParentLabel>sample string 29</conditionalParentLabel>
      <conditionalParentValue>sample string 30</conditionalParentValue>
      <customTabId>sample string 31</customTabId>
      <documentId>sample string 13</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 15</pageNumber>
      <recipientId>sample string 14</recipientId>
      <status>sample string 32</status>
      <tabId>sample string 26</tabId>
      <tabOrder>sample string 33</tabOrder>
      <templateLocked>sample string 27</templateLocked>
      <templateRequired>sample string 28</templateRequired>
      <xPosition>sample string 16</xPosition>
      <yPosition>sample string 17</yPosition>
      <bold>sample string 8</bold>
      <font>sample string 7</font>
      <fontColor>sample string 11</fontColor>
      <fontSize>sample string 12</fontSize>
      <italic>sample string 9</italic>
      <tabLabel>sample string 6</tabLabel>
      <underline>sample string 10</underline>
      <height>2</height>
      <name>sample string 5</name>
      <shared>sample string 3</shared>
      <value>sample string 4</value>
      <width>1</width>
    </note>
  </noteTabs>
  <numberTabs>
    <number>
      <anchorCaseSensitive>sample string 35</anchorCaseSensitive>
      <anchorHorizontalAlignment>sample string 37</anchorHorizontalAlignment>
      <anchorIgnoreIfNotPresent>sample string 34</anchorIgnoreIfNotPresent>
      <anchorMatchWholeWord>sample string 36</anchorMatchWholeWord>
      <anchorString>sample string 30</anchorString>
      <anchorUnits>sample string 33</anchorUnits>
      <anchorXOffset>sample string 31</anchorXOffset>
      <anchorYOffset>sample string 32</anchorYOffset>
      <conditionalParentLabel>sample string 41</conditionalParentLabel>
      <conditionalParentValue>sample string 42</conditionalParentValue>
      <customTabId>sample string 43</customTabId>
      <documentId>sample string 25</documentId>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <mergeField />
      <pageNumber>sample string 27</pageNumber>
      <recipientId>sample string 26</recipientId>
      <status>sample string 44</status>
      <tabId>sample string 38</tabId>
      <tabOrder>sample string 45</tabOrder>
      <templateLocked>sample string 39</templateLocked>
      <templateRequired>sample string 40</templateRequired>
      <xPosition>sample string 28</xPosition>
      <yPosition>sample string 29</yPosition>
      <bold>sample string 20</bold>
      <font>sample string 19</font>
      <fontColor>sample string 23</fontColor>
      <fontSize>sample string 24</fontSize>
      <italic>sample string 21</italic>
      <tabLabel>sample string 18</tabLabel>
      <underline>sample string 22</underline>
      <concealValueOnDocument>sample string 15</concealValueOnDocument>
      <disableAutoSize>sample string 16</disableAutoSize>
      <locked>sample string 14</locked>
      <maxLength>17</maxLength>
      <name>sample string 9</name>
      <originalValue>sample string 11</originalValue>
      <required>sample string 13</required>
      <value>sample string 10</value>
      <width>12</width>
      <re