Deletes the bulk recipient list on a template.

Request

HTTP request

DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

templateIdstring

The id of the template.

Responses

CodeDescriptionReference
200

Successful response.

bulkRecipientsUpdateResponse
400

Error encountered.

errorDetails

SDK Method

Templates::deleteBulkRecipients

Definitions

addressInformation

Contains address information.

address1string

The first line of the user's address. Maximum length: 100 characters.

address2string

The second line of the user's address. Maximum length: 100 characters.

citystring

The user's city.

countrystring

The user's country.

faxstring

A fax number associated with the address, if one is available.

phonestring

A phone number associated with the address.

postalCodestring

The user's postal code.

stateOrProvincestring

The user's state or province.

addressInformationInput

addressInformationaddressInformation

A complex type that contains the following information for the new account: address1, address2, city, country, fax, phone, postalCode and stateOrProvince.

The maximum characters for the strings are:

  • address1, address2, city, country and stateOrProvince: 100 characters
  • postalCode, phone, and fax: 20 characters

Note: If country is US (United States), stateOrProvince codes are validated. Otherwise, stateOrProvince is treated as a non-validated string used to specify a state, province, or region.

displayLevelCodestring

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

A Boolean value that specifies whether the information must be returned in the response.

approve

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

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

buttonTextstring

Specifies the approval text that displays in the tab.

buttonTextMetadatapropertyMetadata

Metadata that indicates whether the buttonText property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

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 whether the yPosition property is editable.

authenticationStatus

A complex element that contains information about a user's authentication status.

accessCodeResulteventResult

The result of a user's attempt to authenticate by using an access code. It returns:

  • Status: Pass or Fail.
  • dateTime: The date and time that the event occurred.
  • FailureDescription: A string containing the details about a failed authentication.
  • VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

ageVerifyResulteventResult

The result of an age verification check. It returns:

  • Status: Pass or Fail.
  • dateTime: The date and time that the event occurred.
  • FailureDescription: A string containing the details about a failed authentication.
  • VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

anySocialIDResulteventResult

Deprecated.

facebookResulteventResult

Deprecated.

googleResulteventResult

Deprecated.

identityVerificationResulteventResult

The result of an Identity Verification workflow.

idLookupResulteventResult

The result of an ID lookup authentication check. It returns:

  • Status: Pass or Fail.
  • dateTime: The date and time that the event occurred.
  • FailureDescription: A string containing the details about a failed authentication.
  • VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

idQuestionsResulteventResult

The result of the user's answers to ID challenge questions. It returns:

  • Status: Pass or Fail.
  • dateTime: The date and time that the event occurred.
  • FailureDescription: A string containing the details about a failed authentication.
  • VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

linkedinResulteventResult

Deprecated.

liveIDResulteventResult

Deprecated.

ofacResulteventResult

The result of an Office of Foreign Asset Control (OFAC) check. It returns:

  • Status: Pass or Fail.
  • dateTime: The date and time that the event occurred.
  • FailureDescription: A string containing the details about a failed authentication.
  • VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

openIDResulteventResult

Deprecated.

phoneAuthResulteventResult

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns:

  • Status: Pass or Fail.
  • dateTime: The date and time that the event occurred.
  • FailureDescription: A string containing the details about a failed authentication.
  • VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

salesforceResulteventResult

Success/failure result of authentication using sign-in with a Salesforce account. It returns:

  • Status: Pass or Fail.
  • dateTime: The date and time that the event occurred.
  • FailureDescription: A string containing the details about a failed authentication.
  • VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

signatureProviderResulteventResult

The result of the user's attempt to authenticate by using a signature provider.

smsAuthResulteventResult

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.

sTANPinResulteventResult

The result of a Student Authentication Network (STAN) authentication check. It returns:

  • Status: Pass or Fail.
  • dateTime: The date and time that the event occurred.
  • FailureDescription: A string containing the details about a failed authentication.
  • VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

twitterResulteventResult

Deprecated.

yahooResulteventResult

Deprecated.

bulkRecipientsUpdateResponse

signersigner

checkbox

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

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

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 whether the requireInitialOnSharedChange property is editable.

selectedstring

When true, the checkbox is selected.

selectedMetadatapropertyMetadata

Metadata that indicates whether the selected property is editable.

sharedstring

When true, this tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

commentThread

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

comments[Comments]

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 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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

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 whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

company

A tab that displays the recipient's company name.

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

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 whether the disableAutoSize property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

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 whether the disableAutoSize property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

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 whether the requireInitialOnSharedChange property is editable.

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 whether the senderRequired property is editable.

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: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

dateSigned

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

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

buttonTextstring

Specifies the decline text displayed in the tab.

buttonTextMetadatapropertyMetadata

Metadata that indicates whether the buttonText property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

declineReasonstring

The reason the recipient declined the document.

declineReasonMetadatapropertyMetadata

Metadata that indicates whether the declineReason property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

dobInformationInput

dateOfBirthstring

Specifies the recipient's date, month, and year of birth.

displayLevelCodestring

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

A Boolean value that specifies whether the information must be returned in the response.

documentVisibility

This object configures a recipient's read/write access to a document.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

errorDetailserrorDetails

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

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

rightsstring

Indicates whether the document is editable:

  • editable
  • read_only

visiblestring

When true, the document is visible to the recipient.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

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 whether the disableAutoSize property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

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 whether the requireInitialOnSharedChange property is editable.

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 whether the senderRequired property is editable.

sharedstring

When set to true, this tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

emailAddress

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

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

envelopeId

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

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

eventResult

Information about the result of an event.

eventTimestampstring

Date/time of the event.

failureDescriptionstring

Reason for failure, if the event failed.

statusstring

Event status.

vendorFailureStatusCodestring

Failure status code, if the event failed.

featureAvailableMetadata

availabiltystring

featureNamestring

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

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 whether the disableAutoSize property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

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 whether the height property is editable.

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 whether the hidden property is editable.

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 whether the isPaymentAmount property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

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

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

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 whether the requireInitialOnSharedChange property is editable.

roundDecimalPlacesstring

The number of decimal places to round to.

roundDecimalPlacesMetadatapropertyMetadata

Metadata that indicates whether the roundDecimalPlaces property is editable.

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 whether the senderRequired property is editable.

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: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

fullName

A tab that displays the recipient's full name.

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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.

idCheckInformationInput

A complex element that contains input information related to a recipient ID check.

addressInformationInputaddressInformationInput

An object that specifies recipient address information and how it is displayed.

dobInformationInputdobInformationInput

An object that specifies recipient date of birth information and how it is displayed.

ssn4InformationInputssn4InformationInput

An object that specifies the last four digits of the recipient's Social Security Number (SSN).

ssn9InformationInputssn9InformationInput

An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.

initialHere

A tab that allows the recipient to initial the document. May be optional.

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates whether the optional property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

scaleValuestring

Sets the size of the tab. This field accepts values from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% of full size.

scaleValueMetadatapropertyMetadata

Metadata that indicates whether the scaleValue property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

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 whether the listSelectedValue property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

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 whether the requireInitialOnSharedChange property is editable.

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 whether the senderRequired property is editable.

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: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

The value to use when the item is selected.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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 whether the selected property is editable.

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 whether the value property is editable.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

note

A tab that displays additional information, in the form of a note, for the recipient.

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

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: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

number

A tab that allows the recipient to enter numbers and decimal (.) points.

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

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 whether the disableAutoSize property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

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 whether the height property is editable.

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 whether the isPaymentAmount property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

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 whether the requireInitialOnSharedChange property is editable.

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 whether the senderRequired property is editable.

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: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

pathExtendedElement

namestring

typestring

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:

&#39;["BankAccount", "CreditCard"]&#39;

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

Metadata that indicates whether the currencyCode property is editable.

customerIdstring

The customer ID.

customMetadatastring

This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under Description in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports.

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

<envelopeID>, <customMetadata>

customMetadataRequiredboolean

A sender-defined field that specifies whether custom metadata is required for the transaction. When set to true, custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account.

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

Metadata that indicates whether the gatewayAccountId property is editable.

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

This property specifies how the signer's collected payment details will be used.

Possible values:

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

paymentSourceIdstring

The payment source ID.

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.

  • future_payment_saved
    The recipient's payment method has been saved to the sender's payment gateway.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 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 whether the fromPageNumber property is editable.

graphicsContextgraphicsContext

Contains details about the style used for the strike through graphic.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

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 whether the pageNumber property is editable.

polyLines[polyLine]

An array of polyLine objects that contain x- and y-coordinates representing the locations of the lines.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

sharedstring

When set to true, indicates that the tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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

Maximum Length: 500 characters.

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 whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

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

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

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

This functionality uses the following rules:

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

    $~><|^+=

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

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

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

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

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

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

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

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

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

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

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.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

selectedstring

When set to true, the radio button is selected.

selectedMetadatapropertyMetadata

Metadata that indicates whether the selected property is editable.

statusstring

The status of the item.

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

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 whether the tabOrder property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

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 whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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 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 whether the conditionalParentValue property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

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 whether the groupName property is editable.

radios[radio]

Specifies the locations and status for radio buttons that are grouped together.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

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 whether the requireInitialOnSharedChange property is editable.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

tooltipMetadatapropertyMetadata

Metadata that indicates whether the tooltip property is editable.

recipientAttachment

attachmentIdstring

The unique identifier for the attachment.

attachmentTypestring

Specifies the type of the attachment for the recipient. Possible values are:

  • .htm
  • .xml

datastring

A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.

labelstring

An optional label for the attachment.

namestring

The name of the attachment.

remoteUrlstring

The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the remoteUrl property to reference the chunked upload as the content in attachment and document-related requests. The remoteUrl property cannot be used for downloads.

recipientEmailNotification

emailBodystring

The body of the email message.

emailBodyMetadatapropertyMetadata

Metadata that indicates whether the emailBody property can be edited.

emailSubjectstring

The subject line for the email notification.

emailSubjectMetadatapropertyMetadata

Metadata that indicates whether the emailSubject property can be edited.

supportedLanguagestring

The language to use for the standard email format and signing view for a recipient.

For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.

Note: This setting affects only DocuSign standard text. Any custom text that you enter for the emailBody and emailSubject of the notification is not translated, and appears exactly as you enter it.

To retrieve the possible values, use the Accounts::listSupportedLanguages method.

supportedLanguageMetadatapropertyMetadata

Metadata that indicates whether the supportedLanguage property can be edited.

recipientIdentityVerification

Specifies ID Verification applied on an envelope by workflow ID. See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other recipient authentication methods.

workflowIdstring

ID of the Identity Verification worklow used to verify recipients' identity.
This ID must match one of the workflowId available to your account.

recipientPhoneAuthentication

A complex type that contains the elements:

  • recipMayProvideNumber: A Boolean value that specifies whether the recipient can use the phone number of their choice.
  • senderProvidedNumbers: A list of phone numbers that the recipient can use.
  • recordVoicePrint: Reserved for DocuSign.
  • validateRecipProvidedNumber: Reserved for DocuSign.

recipMayProvideNumberstring

Boolean. When set to true, the recipient can supply a phone number their choice.

recipMayProvideNumberMetadatapropertyMetadata

Metadata that indicates whether the recipMayProvideNumber property can be edited.

recordVoicePrintstring

Reserved for DocuSign.

recordVoicePrintMetadatapropertyMetadata

Reserved for DocuSign.

senderProvidedNumbers[array]

An array containing a list of phone numbers that the recipient can use for SMS text authentication.

senderProvidedNumbersMetadatapropertyMetadata

Metadata that indicates whether the senderProvidedNumbers property can be edited.

validateRecipProvidedNumberstring

Reserved for DocuSign.

validateRecipProvidedNumberMetadatapropertyMetadata

Reserved for DocuSign.

recipientSignatureInformation

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.

Used only with recipient types In Person Signers and Signers.

fontStylestring

Specifies the font style for the user's signature.

signatureInitialsstring

Specifies the user's signature in initials format.

signatureNamestring

Specifies the user's signature name.

recipientSignatureProvider

An Electronic or Standards Based Signature (digital signature) provider for the signer to use. More information.

sealDocumentsWithTabsOnlystring

By default, electronic seals apply on all documents in an envelope. If any of the documents has a signHere tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.

To apply electronic seals on specific documents only, you must enable the sealDocumentsWithTabsOnly parameter. In this case, Electronic Seal applies only on documents that have signHere tabs set for the Electronic Seal recipient. Other documents won't be sealed.

sealNamestring

Indicates the name of the electronic seal to apply on documents.

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see the current provider list. You can also retrieve the list by using the AccountSignatureProviders::List method.

Example: universalsignaturepen_default

signatureProviderNameMetadatapropertyMetadata

Metadata that indicates whether the signatureProviderName property is editable.

signatureProviderOptionsrecipientSignatureProviderOptions

Not applicable for this object.

recipientSignatureProviderOptions

Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require.

cpfNumberstring

Reserved for DocuSign.

cpfNumberMetadatapropertyMetadata

Reserved for DocuSign.

oneTimePasswordstring

A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.

oneTimePasswordMetadatapropertyMetadata

Metadata that indicates whether the oneTimePassword property is editable.

signerRolestring

The role or capacity of the signing recipient. Examples: Manager, Approver, etc.

signerRoleMetadatapropertyMetadata

Metadata that indicates whether the signerRole property is editable.

smsstring

The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234.

smsMetadatapropertyMetadata

Metadata that indicates whether the sms property is editable.

recipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

senderProvidedNumbers[array]

An array containing a list of phone numbers that the recipient can use for SMS text authentication.

senderProvidedNumbersMetadatapropertyMetadata

Metadata that indicates whether the senderProvidedNumbers property can be edited.

signer

A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

Optional. When set to true, the access code will be added to the email sent to the recipient. This nullifies the security measure of Access Code on the recipient.

agentCanEditEmailstring

Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.

agentCanEditNamestring

Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.

autoNavigationstring

When true, autonavigation is set for the recipient.

bulkRecipientsUristring

Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.

canSignOfflinestring

When set to true, specifies that the signer can perform the signing ceremony offline.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

completedCountstring

Indicates the number of times that the recipient has been through a signing completion for the envelope.

If this number is greater than 0 for a signing group, only the user who previously completed may sign again.

creationReasonstring

The reason why the recipient was created (for example, sender). This property is only returned in responses.

customFields[array]

An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

defaultRecipientstring

When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.

deliveredDateTimestring

The date and time that the envelope was delivered to the recipient.

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

A list of documentVisibility objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true.

emailstring

Recipient email ID to which notifications of the document to sign are sent. Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates whether the signer can edit the recipient's email ID.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: You can set the emailNotification property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level emailSubject and emailBlurb.

embeddedRecipientStartURLstring

Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.

It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set for the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

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

excludedDocuments[array]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Metadata that indicates whether the faxNumber property is editable.

firstNamestring

The recipient's first name. Maximum Length: 50 characters.

firstNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's first name.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:

  • Phone Auth $: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the phoneAuthentication object.
  • SMS Auth $: The recipient must authenticate via SMS. You provide the phone number to use in the smsAuthentication object.
  • ID Check $: The recipient must answer detailed security questions.

Example: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

An object that contains input information related to a recipient ID check.

identityVerificationrecipientIdentityVerification

Specifies ID Verification applied on an envelope by workflow ID.
See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other recipient authentication methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

isBulkRecipientstring

When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.

Note that when this is true the email and name for the recipient becomes bulk@recipient.com and "Bulk Recipient". These fields can not be changed for the bulk recipient.

isBulkRecipientMetadatapropertyMetadata

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's last name.

lockedRecipientPhoneAuthEditablestring

Reserved for DocuSign.

lockedRecipientSmsEditablestring

Reserved for DocuSign.

namestring

The full legal name of the recipient. Maximum Length: 100 characters.

Note: You must always set a value for this property in requests, even if firstName and lastName are set.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the full legal name of the recipient.

notestring

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

noteMetadatapropertyMetadata

Metdata that indicates if the sender can edit the note sent to the recipient in the signing email.

phoneAuthenticationrecipientPhoneAuthentication

When idCheckConfigurationName is set to Phone Auth $, you use this complex type to provide the recipient authentication method details. It contains the following elements:

  • recipMayProvideNumber: Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers: ArrayOfStrings. A list of phone numbers the recipient can use.
  • recordVoicePrint: Reserved for DocuSign.
  • validateRecipProvidedNumber: Reserved for DocuSign.

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the recipient's authentication status.

recipientFeatureMetadata[featureAvailableMetadata]

Metadata about the features that are supported for the recipient type.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientSignatureProviders[recipientSignatureProvider]

The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. More information.

recipientSuppliesTabsstring

Specifies whether the recipient creates the tabs.

recipientTypestring

The recipient type, as specified by the following values:

  • agent: Agent recipients can add name and email information for recipients that appear after the agent in routing order.
  • carbonCopy: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.
  • certifiedDelivery: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.
  • editor: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.
  • inPersonSigner: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.
  • intermediaries: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.
  • seal: Electronic seal recipients represent legal entities.
  • signer: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.
  • witness: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.

recipientTypeMetadatapropertyMetadata

Metadata that indicates whether the recipientType property is editable.

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

requireIdLookupMetadatapropertyMetadata

Metadata that indicates whether the requireIdLookup property is editable.

requireSignerCertificatestring

By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.

This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the recipientSignatureProviders parameter for other types of digital certificates.

Set this parameter to safe to use a SAFE-BioPharma certificate.

The signer must be enrolled in the SAFE program to sign with a SAFE certificate.

requireSignOnPaperstring

When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.

requireUploadSignaturestring

When set to true, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signatureInforecipientSignatureInformation

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.

Used only with recipient types In Person Signers and Signers.

signedDateTimestring

Reserved for DocuSign.

signInEachLocationstring

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).

signInEachLocationMetadatapropertyMetadata

Metadata that indicates whether the signInEachLocation property is editable.

signingGroupIdstring

Optional. The ID of the signing group.

Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

Optional. The name of the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

A complex type that contains information about users in the signing group.

smsAuthenticationrecipientSMSAuthentication

When idCheckConfigurationName is set to SMS Auth $, you use this complex type to provide the recipient authentication method details. It contains the element senderProvidedNumbers, which is an array of phone numbers that the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Deprecated.

statusstring

Recipient status.

statusCodestring

Reserved for DocuSign.

suppressEmailsstring

When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.

tabsEnvelopeRecipientTabs

The tabs to assign to the recipient.

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

The total number of tabs in the documents.

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

signerAttachment

A tab that allows the recipient to attach supporting documents to an envelope.

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When set to false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded in other strings are ignored during the matching process.

  • In words that have dashes, the parts separated by dashes are treated as distinct words.

    Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

  • Letters with accent marks are treated as distinct characters from their unaccented counterparts.

  • For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

    Example: If the anchor string is i, then only one anchor tab is placed in skiing.

  • Unlike punctuation, numbers are not ignored when finding anchor words.

    Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

  • left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
  • right: Aligns the tab’s left side with the last character of the matching anchor word.

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if the anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When set to false, if the input is man then man, manpower, fireman, and penmanship will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded in other strings are ignored during the matching process.

  • In words that have dashes, the parts separated by dashes are treated as distinct words.

    Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

  • Letters with accent marks are treated as distinct characters from their unaccented counterparts.

  • For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

    Example: If the anchor string is i, then only one anchor tab is placed in skiing.

  • Unlike punctuation, numbers are not ignored when finding anchor words.

    Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

Specifies the X axis location of the tab in anchorUnits relative to the anchorString.

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates whether the optional property is editable.

pageNumberstring

The page number on which the tab is located. For supplemental documents, this value must be 1.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

scaleValuestring

Sets the size of the tab. This field accepts values from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% of full size.

scaleValueMetadatapropertyMetadata

Metadata that indicates whether the scaleValue property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

signHere

A tab that allows the recipient to sign a document. May be optional.

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When set to false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded in other strings are ignored during the matching process.

  • In words that have dashes, the parts separated by dashes are treated as distinct words.

    Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

  • Letters with accent marks are treated as distinct characters from their unaccented counterparts.

  • For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

    Example: If the anchor string is i, then only one anchor tab is placed in skiing.

  • Unlike punctuation, numbers are not ignored when finding anchor words.

    Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

  • left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
  • right: Aligns the tab’s left side with the last character of the matching anchor word.

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if the anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When set to false, if the input is man then man, manpower, fireman, and penmanship will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded in other strings are ignored during the matching process.

  • In words that have dashes, the parts separated by dashes are treated as distinct words.

    Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

  • Letters with accent marks are treated as distinct characters from their unaccented counterparts.

  • For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

    Example: If the anchor string is i, then only one anchor tab is placed in skiing.

  • Unlike punctuation, numbers are not ignored when finding anchor words.

    Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

Specifies the X axis location of the tab in anchorUnits relative to the anchorString.

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

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 whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

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.

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates whether the optional property is editable.

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

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

scaleValuestring

Sets the size of the tab. This field accepts values from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% of full size.

scaleValueMetadatapropertyMetadata

Metadata that indicates whether the scaleValue property is editable.

stampTypestring

The type of stamp. Valid values are:

  • signature: A signature image. This is the default value.
  • stamp: A stamp image.
  • null

stampTypeMetadatapropertyMetadata

Metadata that indicates whether the stampType property is editable.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

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 whether the yPosition property is editable.

smartSection

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When set to false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded in other strings are ignored during the matching process.

  • In words that have dashes, the parts separated by dashes are treated as distinct words.

    Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

  • Letters with accent marks are treated as distinct characters from their unaccented counterparts.

  • For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

    Example: If the anchor string is i, then only one anchor tab is placed in skiing.

  • Unlike punctuation, numbers are not ignored when finding anchor words.

    Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

  • left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
  • right: Aligns the tab’s left side with the last character of the matching anchor word.

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if the anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When set to false, if the input is man then man, manpower, fireman, and penmanship will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded in other strings are ignored during the matching process.

  • In words that have dashes, the parts separated by dashes are treated as distinct words.

    Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

  • Letters with accent marks are treated as distinct characters from their unaccented counterparts.

  • For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

    Example: If the anchor string is i, then only one anchor tab is placed in skiing.

  • Unlike punctuation, numbers are not ignored when finding anchor words.

    Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

Specifies the X axis location of the tab in anchorUnits relative to the anchorString.

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

caseSensitiveboolean

When true, the startAnchor and endAnchor for the Smart Section must match both the case and the content of the strings in the HTML.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

displaySettingssmartSectionDisplaySettings

This object defines how the HTML section inside the startAnchor and endAnchor displays.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

endAnchorstring

Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.

Note: A start anchor, an end anchor, or both are required.

endPositionsmartSectionAnchorPosition

The last index position in the result set.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

mergeFieldXmlstring

overlayTypestring

The type of overlay to draw on the document. The following overlay types are supported:

  • line
  • outline

overlayTypeMetadatapropertyMetadata

Metadata that indicates whether the overlayType property is editable.

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

removeEndAnchorboolean

When true, removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.

removeStartAnchorboolean

When true, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.

sharedstring

When true, the tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

startAnchorstring

Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.

Note: A start anchor, an end anchor, or both are required.

startPositionsmartSectionAnchorPosition

The starting index position of the current result set.

statusstring

The status of the tab. Possible values are:

  • active: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.

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 whether the tabOrder property is editable.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

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

These properties define how a Smart Section displays. A Smart Section is a type of display section.

cellStylestring

Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of responsive_table or responsive_table_single_column types.

collapsibleSettingssmartSectionCollapsibleDisplaySettings

This object defines the appearance and function of a collapsible section or item.

displaystring

Indicates the display type. Must be one of the following enum values:

  • inline: Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page.
  • collapsible: The HTML in the section may be expanded or collapsed. By default, the section is expanded.
  • collapsed: The HTML in the section may be expanded or collapsed. By default, the section is collapsed.
  • responsive_table: Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the startAnchor and endAnchor positions.
  • responsive_table_single_column: Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the startAnchor and endAnchor positions. The table is converted to a single column in which each column becomes a row and is stacked.
  • print_only: Prevents this portion of the HTML from displaying in the responsive signing view.

displayLabelstring

The label for the display section.

displayOrderinteger

The position on the page where the display section appears.

displayPageNumberinteger

The number of the page on which the display section appears.

hideLabelWhenOpenedboolean

When true, the displayLabel is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the display property is collapsed.

inlineOuterStylestring

Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the display property is inline.

labelWhenOpenedstring

The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the display property is collapsed.

scrollToTopWhenOpenedboolean

When true and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the display property is collapsed.

tableStylestring

Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the display property is responsive_table or responsive_table_single_column.

socialAuthentication

authenticationstring

Reserved for DocuSign.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When set to false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded in other strings are ignored during the matching process.

  • In words that have dashes, the parts separated by dashes are treated as distinct words.

    Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

  • Letters with accent marks are treated as distinct characters from their unaccented counterparts.

  • For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

    Example: If the anchor string is i, then only one anchor tab is placed in skiing.

  • Unlike punctuation, numbers are not ignored when finding anchor words.

    Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

  • left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
  • right: Aligns the tab’s left side with the last character of the matching anchor word.

Note: You can only specify the value of this property in POST requests.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if the anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When set to false, if the input is man then man, manpower, fireman, and penmanship will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded in other strings are ignored during the matching process.

  • In words that have dashes, the parts separated by dashes are treated as distinct words.

    Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

  • Letters with accent marks are treated as distinct characters from their unaccented counterparts.

  • For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

    Example: If the anchor string is i, then only one anchor tab is placed in skiing.

  • Unlike punctuation, numbers are not ignored when finding anchor words.

    Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

Specifies the X axis location of the tab in anchorUnits relative to the anchorString.

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.

Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.

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 whether the bold property is editable.

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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

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 whether the conditionalParentValue property is editable.

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 whether the customTabId property is editable.

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 whether the disableAutoSize property is editable.

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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 whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

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 whether the fontSize property is editable.

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 whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

An optional value that describes the maximum length of the property when the property is a string.

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

The initial value of the tab when it was sent to the recipient.

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

The page number on which the tab is located. For supplemental documents, this value must be 1.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientIdGuidstring

The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

When set to true, the signer is required to fill out this tab.

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

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 whether the requireInitialOnSharedChange property is editable.

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 whether the senderRequired property is editable.

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: The tab is active, but the recipient has not yet interacted with it.
  • signed: The recipient signed the tab.
  • declined: The recipient declined the envelope.
  • na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

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 whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

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 whether the tabOrder property is editable.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

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 whether the templateLocked property is editable.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

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 whether the xPosition property is editable.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

ssn4InformationInput

displayLevelCodestring

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

A Boolean value that specifies whether the information must be returned in the response.

ssn4string

The last four digits of the recipient's Social Security Number (SSN).

ssn9InformationInput

displayLevelCodestring

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay

ssn9string

The recipient's full Social Security Number (SSN).

tabGroup

anchorCaseSensitivestring

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When set to false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match.

This functionality uses the following rules:

  • Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

    $~><|^+=

    For example, the anchorString water will match on the string Fetch a pail of water.

  • Strings embedded