Deletes one or more tabs associated with a recipient in a template.

Request

HTTP request

DELETE /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Parameters

Parameter name Value Description
Path parameters
accountId string

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

recipientId string

The recipientId used when the envelope or template was created.

templateId string

The ID of the template being accessed.

Request Body

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Templates::deleteTabs

Definitions Expand All | Collapse All

TemplateRecipientTabs

Template tabs

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.

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.

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.

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.

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.

approve

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

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

buttonText string

Specifies the approval text displayed in the tab.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
height integer (int32)

Height of the tab in pixels.

italic string

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

mergeField mergeField
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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

checkbox

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

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
locked string

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

mergeField mergeField
name string

Specifies the tool tip text for the tab.

pageNumber string

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

recipientId string

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

required string

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

requireInitialOnSharedChange string

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

selected string

When set to true, the checkbox is selected.

shared string

When set to true, this custom tab is shared.

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

xPosition string

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

yPosition string

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

company

A tab that displays the recipient's company name.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

concealValueOnDocument string

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.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

disableAutoSize string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
italic string

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

locked string

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

maxLength integer (int32)

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

mergeField mergeField
name string

Specifies the tool tip text for the tab.

originalValue string

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

pageNumber string

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

recipientId string

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

required string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

value string

Specifies the value of the tab.

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

concealValueOnDocument string

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.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

disableAutoSize string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
italic string

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

locked string

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

maxLength integer (int32)

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

mergeField mergeField
name string
originalValue string

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

pageNumber string

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

recipientId string

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

requireAll string

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

required string

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

requireInitialOnSharedChange string

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

senderRequired string

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.

shared string

When set to true, this custom tab is shared.

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

validationMessage string

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

validationPattern string

A regular expressionn used to validate input for the tab.

value string

Specifies the value of the tab.

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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

dateSigned

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

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
italic string

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

mergeField mergeField
name string
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

value string

Specifies the value of the tab.

xPosition string

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

yPosition string

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

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

buttonText string

Specifies the decline text displayed in the tab.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

declineReason string

The reason the recipient declined the document.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
height integer (int32)

Height of the tab in pixels.

italic string

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

mergeField mergeField
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

concealValueOnDocument string

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.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

disableAutoSize string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
italic string

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

locked string

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

maxLength integer (int32)

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

mergeField mergeField
name string
originalValue string

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

pageNumber string

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

recipientId string

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

requireAll string

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

required string

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

requireInitialOnSharedChange string

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

senderRequired string

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.

shared string

When set to true, this custom tab is shared.

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

validationMessage string

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

validationPattern string

A regular expressionn used to validate input for the tab.

value string

Specifies the value of the tab.

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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

emailAddress

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

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
italic string

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

mergeField mergeField
name string
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

value string

Specifies the value of the tab.

xPosition string

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

yPosition string

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

envelopeId

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

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
italic string

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

mergeField mergeField
name string
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

xPosition string

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

yPosition string

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

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
italic string

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

mergeField mergeField
name string
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

value string

Specifies the value of the tab.

xPosition string

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

yPosition string

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

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

concealValueOnDocument string

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.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

disableAutoSize string

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.

documentId string

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

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
fontColor string

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

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

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
formula string

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

hidden string

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.
isPaymentAmount string

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.

italic string

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

locked string

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

maxLength integer (int32)

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

mergeField mergeField
name string
originalValue string

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

pageNumber string

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

paymentDetails paymentDetails

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.

recipientId string

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

requireAll string

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

required string

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

requireInitialOnSharedChange string

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

roundDecimalPlaces string
senderRequired string

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.

shared string

When set to true, this custom tab is shared.

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

validationMessage string

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

validationPattern string

A regular expressionn used to validate input for the tab.

value string

Specifies the value of the tab.

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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

fullName

A tab that displays the recipient's full name.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails