> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # Add tabs for recipient POST https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs Content-Type: application/json Adds one or more tabs for a recipient. Reference: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templaterecipienttabs/create ## Authentication - `Authorization` header (required) (prefixed with ` Bearer `) — OAuth 2.0 access token (JWT or auth-code grant). Sent as `Authorization: Bearer ` on every request except `GET /v2.1` and `GET /service_information`, which are public discovery endpoints. ## Servers - `https://demo.docusign.net/restapi` (Demo, default) - `https://www.docusign.net/restapi` (Production) ## Request ### Path parameters - `accountId` (string, required) — The external account number (int) or account ID Guid. - `recipientId` (string, required) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `templateId` (string, required) — The ID of the template. ### Body (application/json) This endpoint expects a templateTabs. - `approveTabs` (list of approve, optional) — A list of [Approve tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Approve tab enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. The value of an approve tab can't be set. - `checkboxTabs` (list of checkbox, optional) — A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. - `commentThreadTabs` (list of commentThread, optional) — An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. - `commissionCountyTabs` (list of commissionCounty, optional) — A list of [Commission County tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionExpirationTabs` (list of commissionExpiration, optional) — A list of [Commission Expiration tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionNumberTabs` (list of commissionNumber, optional) — A list of [Commission Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionStateTabs` (list of commissionState, optional) — A list of [Commission State tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `companyTabs` (list of company, optional) — A list of [Company tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company). A Company tab displays a field for the name of the recipient's company. This value can't be set. - `dateSignedTabs` (list of dateSigned, optional) — A list of [Date Signed tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date Signed tab displays the date that the recipient signed the document. This value can't be set. - `dateTabs` (list of date, optional) — A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. - `declineTabs` (list of decline, optional) — A list of [Decline tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. - `drawTabs` (list of draw, optional) — A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. - `emailAddressTabs` (list of emailAddress, optional) — A list of [Email Address tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. - `emailTabs` (list of email, optional) — A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email tab enables 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. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. - `envelopeIdTabs` (list of envelopeId, optional) — A list of [Envelope ID tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid). An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. - `firstNameTabs` (list of firstName, optional) — A list of [First Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname). A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. - `formulaTabs` (list of formulaTab, optional) — A list of [Formula tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). 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. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html). If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html). - `fullNameTabs` (list of fullName, optional) — A list of [Full Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Full Name tab displays the recipient's full name. This value can't be set. - `initialHereTabs` (list of initialHere, optional) — A list of [Initial Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to initial the document. May be optional. This value can't be set. - `lastNameTabs` (list of lastName, optional) — A list of [Last Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. - `listTabs` (list of list, optional) — An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `notarizeTabs` (list of notarize, optional) — A list of [Notarize tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. - `notarySealTabs` (list of notarySeal, optional) — A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). - `noteTabs` (list of note, optional) — A list of [Note tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Note tab displays additional information to the recipient in the form of a note. This value can be set. - `numberTabs` (list of number, optional) — A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). - `numericalTabs` (list of numerical, optional) — A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). - `phoneNumberTabs` (list of phoneNumber, optional) — A list of [Phone Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). - `polyLineOverlayTabs` (list of polyLineOverlay, optional) — This type of tab enables the recipient to strike through document text. This value can't be set. - `prefillTabs` (prefillTabs, optional) — Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. - `signerAttachmentTabs` (list of signerAttachment, optional) — A list of [Signer Attachment tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. - `signHereTabs` (list of signHere, optional) — A list of [Sign Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to sign a document. May be optional. This value can't be set. - `smartSectionTabs` (list of smartSection, optional) — A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. - `ssnTabs` (list of ssn, optional) — A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. - `tabGroups` (list of tabGroup, optional) — An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. - `textTabs` (list of text, optional) — A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `titleTabs` (list of title, optional) — A list of [Title tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Title tab displays the recipient's title. This value can't be set. - `viewTabs` (list of view, optional) — A list of [View tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A View tab is used with an Approve tab to handle supplemental documents. This value can be set. - `zipTabs` (list of zip, optional) — A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. ## Response ### 201 Successful response. - `approveTabs` (list of approve, optional) — A list of [Approve tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Approve tab enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. The value of an approve tab can't be set. - `checkboxTabs` (list of checkbox, optional) — A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. - `commentThreadTabs` (list of commentThread, optional) — An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. - `commissionCountyTabs` (list of commissionCounty, optional) — A list of [Commission County tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionExpirationTabs` (list of commissionExpiration, optional) — A list of [Commission Expiration tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionNumberTabs` (list of commissionNumber, optional) — A list of [Commission Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionStateTabs` (list of commissionState, optional) — A list of [Commission State tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `companyTabs` (list of company, optional) — A list of [Company tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company). A Company tab displays a field for the name of the recipient's company. This value can't be set. - `dateSignedTabs` (list of dateSigned, optional) — A list of [Date Signed tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date Signed tab displays the date that the recipient signed the document. This value can't be set. - `dateTabs` (list of date, optional) — A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. - `declineTabs` (list of decline, optional) — A list of [Decline tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. - `drawTabs` (list of draw, optional) — A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. - `emailAddressTabs` (list of emailAddress, optional) — A list of [Email Address tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. - `emailTabs` (list of email, optional) — A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email tab enables 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. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. - `envelopeIdTabs` (list of envelopeId, optional) — A list of [Envelope ID tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid). An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. - `firstNameTabs` (list of firstName, optional) — A list of [First Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname). A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. - `formulaTabs` (list of formulaTab, optional) — A list of [Formula tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). 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. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html). If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html). - `fullNameTabs` (list of fullName, optional) — A list of [Full Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Full Name tab displays the recipient's full name. This value can't be set. - `initialHereTabs` (list of initialHere, optional) — A list of [Initial Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to initial the document. May be optional. This value can't be set. - `lastNameTabs` (list of lastName, optional) — A list of [Last Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. - `listTabs` (list of list, optional) — An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `notarizeTabs` (list of notarize, optional) — A list of [Notarize tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. - `notarySealTabs` (list of notarySeal, optional) — A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). - `noteTabs` (list of note, optional) — A list of [Note tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Note tab displays additional information to the recipient in the form of a note. This value can be set. - `numberTabs` (list of number, optional) — A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). - `numericalTabs` (list of numerical, optional) — A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). - `phoneNumberTabs` (list of phoneNumber, optional) — A list of [Phone Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). - `polyLineOverlayTabs` (list of polyLineOverlay, optional) — This type of tab enables the recipient to strike through document text. This value can't be set. - `prefillTabs` (prefillTabs, optional) — Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. - `signerAttachmentTabs` (list of signerAttachment, optional) — A list of [Signer Attachment tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. - `signHereTabs` (list of signHere, optional) — A list of [Sign Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to sign a document. May be optional. This value can't be set. - `smartSectionTabs` (list of smartSection, optional) — A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. - `ssnTabs` (list of ssn, optional) — A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. - `tabGroups` (list of tabGroup, optional) — An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. - `textTabs` (list of text, optional) — A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `titleTabs` (list of title, optional) — A list of [Title tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Title tab displays the recipient's title. This value can't be set. - `viewTabs` (list of view, optional) — A list of [View tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A View tab is used with an Approve tab to handle supplemental documents. This value can be set. - `zipTabs` (list of zip, optional) — A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. ## Errors ### 400 Bad Request Error Error encountered. - `errorCode` (string, optional) — The code associated with the error condition. - `message` (string, optional) — A brief message describing the error condition. ## Types ### approve A tab that allows the recipient to approve documents without placing a signature or initials on the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — Specifies the approval text that displays in the tab. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — 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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Approve tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### checkbox A tab that allows the recipient to select a yes/no (on/off) option. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — 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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — This property does not apply to `checkbox` tabs. To require users to check at least one, or at most some number of checkboxes, associate the checkbox tabs with a [`tabGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups). Then set the following `tabGroup` properties: - [`maximumAllowed`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed) - [`minimumRequired`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired) - [`groupRule`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule) specifies how the other two properties are interpreted. You can find an example at [Stack Overflow](https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277). - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `selected` (string, optional) — When **true,** the checkbox is selected. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `selectedOriginal` (string, optional) - `selectedOriginalMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commentThread - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `comments` (list of comment, optional) — An array of comment tabs that contain information about users' comments on documents. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `threadId` (string, optional) — The unique identifier for the comment thread. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionCounty A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionExpiration A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionNumber A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionState A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### company A tab that displays the recipient's company name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### dateSigned A tab that displays the date that the recipient signed the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `timestampStandardized` (string, optional) - `tooltip` (string, optional) — **Note:** Date Signed tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### date A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### decline A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — Specifies the decline text displayed in the tab. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `declineReason` (string, optional) — The reason the recipient declined the document. - `declineReasonMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Decline tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### draw A tab that allows the recipient to add a free-form drawing to the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `allowSignerUpload` (string, optional) — When **true,** the recipient can upload an image to use as the background of the drawing field. The default value is **false.** - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `useBackgroundAsCanvas` (string, optional) - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### emailAddress A tab that displays the recipient's email as entered in the recipient information. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — 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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Email Address tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### email A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### envelopeId A tab that displays the envelope ID. **Note:** The eSignature API uses the name `envelopeId` two ways: - As a _property_ of type `string` used to identify an envelope by its GUID. - As an _object_ used to represent an envelope tab that displays the envelope's GUID. - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### formulaTab The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] 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][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extendPaymentConfiguration` (extendPaymentConfiguration, optional) - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `formula` (string, optional) — 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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `hidden` (string, optional) — 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. - `hiddenMetadata` (propertyMetadata, optional) — Metadata about a property. - `isPaymentAmount` (string, optional) — 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. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `paymentDetails` (paymentDetails, optional) — When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `roundDecimalPlaces` (string, optional) — The number of decimal places to round to. - `roundDecimalPlacesMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### fullName A tab that displays the recipient's full name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### initialHere A tab that allows the recipient to initial the document. May be optional. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — When set to `true`, requires a hand-drawn initial by the signer. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -7) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -7) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### lastName A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### list This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) objects to specify the selectable options. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `listItems` (list of listItem, optional) — 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. - `listSelectedValue` (string, optional) — The value in the list that is selected by default. - `listSelectedValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — The value to use when the item is selected. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a 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. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### notarySeal A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### note A tab that displays additional information, in the form of a note, for the recipient. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Note tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### number Number tabs validate that the entered value is a number. They do not support advanced validation or display options. See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) to learn more about this tab type. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `formula` (string, optional) — 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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `isPaymentAmount` (string, optional) — 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. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### numerical Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) to learn more about this tab type. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This ID must refer to an existing document. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxNumericalValue` (string, optional) — The maximum value that the numerical tab can take on. The largest value allowed, and the default if not specified, is `999999999.99` - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `minNumericalValue` (string, optional) — The minimum value that the numerical tab can take on. The smallest value allowed, and the default if not specified, is `-999999999.99` - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `numericalValue` (string, optional) — The raw numerical value of the tab. For example, if the locale policy is `en-US` and the `numericalValue` is `-1234.56`, the `value` property will contain the string `"($ 1,234.56)"`. - `originalNumericalValue` (string, optional) — The original value of the tab. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationType` (string, optional) — Specifies how numerical data is validated. Valid values: - `number` - `currency` - `value` (string, optional) — The `numericalValue` of the tab displayed according to its locale policy. For example, if the locale policy is `en-US` and the `numericalValue` is `-1234.56`, this property will contain the string `"($ 1,234.56)"`. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### phoneNumber A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `graphicsContext` (graphicsContext, optional) - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `overlayType` (string, optional) — The type of overlay to use. The API currently supports only the `outline` overlay type. - `overlayTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `polyLines` (list of polyLine, optional) — An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** indicates that the tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### prefillTabs Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - `checkboxTabs` (list of checkbox, optional) — A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. - `dateTabs` (list of date, optional) — A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. - `emailTabs` (list of email, optional) — A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email tab enables 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. This value can be set. 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. - `numberTabs` (list of number, optional) — A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). - `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. - `senderCompanyTabs` (list of senderCompany, optional) - `senderNameTabs` (list of senderName, optional) - `ssnTabs` (list of ssn, optional) — A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. - `tabGroups` (list of tabGroup, optional) — An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. - `textTabs` (list of text, optional) — A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `zipTabs` (list of zip, optional) — A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. ### radioGroup This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) objects associated with the group. Only one radio button can be selected in a group. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupName` (string, optional) — The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. - `groupNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `radios` (list of radio, optional) — Specifies the locations and status for radio buttons that are grouped together. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `source` (string, optional) - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `tooltipMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. ### signerAttachment A tab that allows the recipient to attach supporting documents to an envelope. - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — Reserved for Docusign. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### signHere A tab that allows the recipient to sign a document. May be optional. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — When set to `true`, requires a hand-drawn signature by the signer. - `height` (string, optional) — Not applicable to Sign Here tab. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `isSealSignTab` (string, optional) — When **true,** the tab contains a visual representation for an electronic seal in a document. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Scales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `stamp` (stamp, optional) - `stampType` (string, optional) — The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null - `stampTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — Not applicable to Sign Here tab. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+1, -7) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+1, -7) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### smartSection - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `caseSensitive` (boolean, optional) — When **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `displaySettings` (smartSectionDisplaySettings, optional) — These properties define how a Smart Section displays. A Smart Section is a type of display section. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `endAnchor` (string, optional) — Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. - `endPosition` (smartSectionAnchorPosition, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `overlayType` (string, optional) — The type of overlay to draw on the document. The following overlay types are supported: - `line` - `outline` - `overlayTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `removeEndAnchor` (boolean, optional) — When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. - `removeStartAnchor` (boolean, optional) — When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `startAnchor` (string, optional) — Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. - `startPosition` (smartSectionAnchorPosition, optional) - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### tabGroup - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupLabel` (string, optional) — A unique identifier for a tab group. To assign a tab to the `tabGroup`, you assign the `TabGroupLabel` to the `tab.TabGroupLabels` array. - `groupLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupRule` (string, optional) — Specifies how `maximumAllowed` and `minimumRequired` are interpreted when selecting tabs in a `tabGroup`. Possible values are: - `SelectAtLeast` - `SelectAtMost` - `SelectExactly` - `SelectARange` - `groupRuleMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `maximumAllowed` (string, optional) — The maximum number of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. - `maximumAllowedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `minimumRequired` (string, optional) — The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. - `minimumRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab group will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabScope` (string, optional) — The scope of the tab group. Possible values are: - `document` - `envelope` (default) - `tabScopeMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### text A tab that allows the recipient to enter any type of text. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) — A description of the tab that can match the original document caption or describe its intent. When a Web Form is generated from a template this value will be used as the caption of the field shown on the form. - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `formula` (string, optional) — 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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `isPaymentAmount` (string, optional) — 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. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — The `shared` and `shareToRecipients` properties work together to define signing behavior. If `"shared": "true"`, it overrides `shareToRecipients`, and the tab is shared with all recipients. In mixed cases, the API prioritizes `"shared": "true"` for all recipients, or `"shared": "false"` for specified recipients. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — The value of the text tab. Maximum length: 4000 bytes. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### title A tab that displays the recipient's title. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### view This tab is used with the Approve tab to handle supplemental documents. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — The text to display on the button. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the recipient must click the **View** button for the supporting document prior to completing the signing process. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requiredRead` (string, optional) — When **true,** the recipient must read through the document. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### zip A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `useDash4` (string, optional) — When **true,** ZIP+4 format is used. - `useDash4Metadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### propertyMetadata Metadata about a property. - `options` (list of string, optional) — An array of option strings supported by this setting. - `rights` (string, optional) — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` ### connectedObjectDetails - `recordId` (string, optional) ### errorDetails This object describes errors that occur. It is only valid for responses, and ignored in requests. - `errorCode` (string, optional) — The code associated with the error condition. - `message` (string, optional) — A brief message describing the error condition. ### extensionData - `actionContract` (string, optional) — The template that defines the action in an extension app. - `actionInputKey` (string, optional) — A key that represents the input data required for verification. The value of this property determines the actual data type to be verified. The supported values are: - `countryCode` - `phoneNumber` - `street1` - `locality` - `subdivision` - `email` - `firstName` - `lastName` - `vin` - `ssn` - `countryOrRegion` - `fein` - `businessName` - `postalCode` - `accountNumber` - `accountType` - `routingNumber` - `dateOfBirth` - `stateOfRegistration` - `countryOfRegistration` - `actionName` (string, optional) — The name of an action used in an extension app. - `applicationId` (string, optional) — The unique ID of an extension app. - `applicationName` (string, optional) — The name of an extension app. - `connectedFieldsData` (connectedData, optional) - `connectionInstances` (list of connectionInstance, optional) — An object containing data that identifies an extension app's connection to the connected field. - `extensionContract` (string, optional) — The template that defines the extension in an extension app. This corresponds to the extension template value in the extension app's manifest file. - `extensionGroupId` (string, optional) — The unique ID of the group of extensions within an extension app. - `extensionName` (string, optional) — The name of the extension used in an extension app. - `extensionPolicy` (string, optional) — An envelope or account-level configuration that determines a document's signing policy. Set this to property value to `mustVerifyToSign` to require that this text tab must be validated by an extension app before the envelope can be completed. - `publisherName` (string, optional) — The name of the extension app publisher. - `requiredForExtension` (string, optional) — A boolean value that indicates whether a field must pass verification before a signer can sign a document. ### localePolicyTab Allows you to customize locale settings. - `addressFormat` (string, optional) — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw` - `calendarType` (string, optional) — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist` - `cultureName` (string, optional) — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. - `currencyCode` (string, optional) — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL` - `currencyNegativeFormat` (string, optional) — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default` `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar` `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89` `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89` `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89` `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym` `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar` `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym` `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89` `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89` `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567` `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89` `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar` `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89` `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89` `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89` `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89` `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89` `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym` `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym` `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar` `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar` `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym` `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89` `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar` `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar` `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar` `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar` `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar` `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar` `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar` `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar` `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar` `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar` `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar` `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567` `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89` `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89` `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567` `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567` `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89` `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89` `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89` `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym` `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89` `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym` `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus` `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89` `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar` `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89` `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89` `-$123 456 789,00` - `currencyPositiveFormat` (string, optional) — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default` Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89` `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89` `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym` `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym` `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89` `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567` `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89` `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89` `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89` `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym` `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89` `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89` `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym` `1 234 567,89$` - `CSym_1_Period_234_Period_567` `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym` `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89` `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89` `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym` `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89` `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym` `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89` `$123 456 789,00` (en-ZA, es-CR) - `customDateFormat` (string, optional) - `customTimeFormat` (string, optional) - `dateFormat` (string, optional) — Specifies the date format. Valid values: - `default` used the UI's - `longformat` use the UI's long format - `dd_mm_yy` dd-MM-yy - `dd_mmm_yy` dd-MMM-yy - `dd_mm_yyyy` dd-MM-yyyy - `dd_mmm_yyyy` dd-MMM-yyyy - `ddmmmmyyyy` dd MMMM yyyy - `ddmmyyyy` dd/MM/yyyy - `ddmmyyyy_de` dd.MM.yyyy - `dmyyyy` d/M/yyyy - `d_m_yyyy` d-M-yyyy - `mmmd_yyyy` MMM d, yyyy - `mmm_dd_yyyy` MMM-dd-yyyy - `mmmmd_yyyy` MMMM d, yyyy - `mm_dd_yyyy` MM-dd-yyyy - `mdyyyy` M/d/yyyy - `yyyy_mmm_dd` yyyy-MMM-dd - `yyyy_mm_dd` yyyy-MM-dd - `yyyymmdd` yyyy/MM/dd - `yyyymd` yyyy/M/d - `custom` Customer set own value - `mmddyyyy` MM/dd/yyyy - `mmddyy` MM/dd/yy - `yyyy_mmmm_d` yyyy MMMM d - `initialFormat` (string, optional) — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1` "WG" - `last2` "GA" - `first2` "WI" - `last2_cjk` first two characters from last name in CJK characters. - `nameFormat` (string, optional) — Describes how names are displayed. Valid values: - `first_middle_last` William Henry Gates - `full` Mr William Henry Gates III - `last_first` Gates William - `lastfirst` GatesWilliam - `last_first_cjk` Gates William only with CJK characters - `lastfirst_cjk` GatesWilliam only with CJK characters - `timeFormat` (string, optional) — Specifies the time format. Valid values: - `none` None - `hh_mm` hh:mm - `hhmm` HH:mm - `hhmmss` HH:mm:ss - `hhmmsstt` HH:mm:ss tt - `hhmmtt` HH:mm tt - `hmm` h:mm - `hmmss` h:mm:ss - `hmmsstt` h:mm:ss tt - `hmmtt` h:mm tt - `custom` Customer-set format - `timeZone` (string, optional) — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime` - `useLongCurrencyFormat` (string, optional) — When **true,** use the long currency format for the locale. ### mergeField Contains information for transferring values between Salesforce data fields and Docusign tabs. - `allowSenderToEdit` (string, optional) — When **true,** the sender can modify the value of the `mergeField` tab during the sending process. - `allowSenderToEditMetadata` (propertyMetadata, optional) — Metadata about a property. - `configurationType` (string, optional) — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. - `configurationTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `path` (string, optional) — Sets the object associated with the custom tab. Currently this is the Salesforce Object. - `pathExtended` (list of pathExtendedElement, optional) — Reserved for Docusign. - `pathExtendedMetadata` (propertyMetadata, optional) — Metadata about a property. - `pathMetadata` (propertyMetadata, optional) — Metadata about a property. - `row` (string, optional) — Specifies the row number in a Salesforce table that the merge field value corresponds to. - `rowMetadata` (propertyMetadata, optional) — Metadata about a property. - `writeBack` (string, optional) — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field. - `writeBackMetadata` (propertyMetadata, optional) — Metadata about a property. ### smartContractInformation - `code` (string, optional) — Reserved for Docusign. - `uri` (string, optional) — Reserved for Docusign. ### comment - `envelopeId` (string, optional) — The Guid of the envelope the comment thread belongs to. - `hmac` (string, optional) — Reserved for Docusign. - `id` (string, optional) — The unique identifier for the comment. - `mentions` (list of string, optional) — An array of userIds that are mentioned directly in the body of a comment. - `read` (boolean, optional) — When **true,** indicates that the comment was read. - `sentByEmail` (string, optional) — The email address of the user who created the comment. - `sentByFullName` (string, optional) — The full name of the user who created the comment. - `sentByImageId` (string, optional) — Reserved for Docusign. - `sentByInitials` (string, optional) — The initials of the user who created the comment. - `sentByRecipientId` (string, optional) — The recipient ID of the user who created the comment. - `sentByUserId` (string, optional) — The user ID of the user who created the comment. - `signingGroupId` (string, optional) — The ID of the signing group that can view the comment or that created the comment. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `subject` (string, optional) — The subject of the envelope. - `tabId` (string, optional) — The unique identifier for the tab that represents the comment thread. - `text` (string, optional) — The content of the comment, as UTF-8 text. Maximum Length: 500 characters. **Note:** The maximum size allowed for the entire message body is 32 KB. - `threadId` (string, optional) — The unique identifier for the comment thread. - `threadOriginatorId` (string, optional) — The userId of the user who created the thread. - `timestamp` (string, optional) — The time the comment was created. - `timeStampFormatted` (string, optional) — The time the comment was created, formatted according to the format of the user who created the comment. - `visibleTo` (list of string, optional) — The user IDs of the users that the comment is visible to. ### extendPaymentConfiguration - `appId` (string, optional) - `connectionInstanceId` (string, optional) - `currency` (string, optional) - `durationEnd` (string, optional) - `durationStart` (string, optional) - `lineItems` (list of extendPaymentLineItem, optional) - `paymentDueDays` (string, optional) - `paymentMethods` (list of string, optional) - `paymentMode` (string, optional) - `tabRole` (string, optional) ### paymentDetails When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `allowedPaymentMethods` (list of string, optional) — An array of accepted payment methods: - `CreditCard` - `ApplePay` - `AndroidPay` - `BankAccount` For example, if you only accept credit cards and ACH transfers, you would set this property to: `'["BankAccount", "CreditCard"]'` Do not specify `BankAccount` (ACH) if you are also using in-person signing. - `chargeId` (string, optional) — 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. - `currencyCode` (string, optional) — Specifies the three-letter [ISO 4217](https://en.wikipedia.org/wiki/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. - `currencyCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `customerId` (string, optional) — The customer ID. - `customMetadata` (string, optional) — 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: `, ` - `customMetadataRequired` (boolean, optional) — A sender-defined field that specifies whether custom metadata is required for the transaction. When **true,** custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account. - `gatewayAccountId` (string, optional) — 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. - `gatewayAccountIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `gatewayDisplayName` (string, optional) — Display name of the gateway connected to sender's Docusign account. Possible values are: Stripe, Braintree, Authorize.Net, CyberSource, Zuora, Elavon. - `gatewayName` (string, optional) — Name of the gateway connected to sender's Docusign account. Possible values are: - `Stripe` - `Braintree` - `AuthorizeDotNet` - `CyberSource` - `Zuora` - `Elavon` - `lineItems` (list of paymentLineItem, optional) — 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. - `paymentOption` (string, optional) — This property specifies how the signer's collected payment details will be used. Valid 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. - `paymentSourceId` (string, optional) — The payment source ID. - `signerValues` (paymentSignerValues, optional) - `status` (string, optional) — 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. - `subGatewayName` (string, optional) - `total` (money, optional) — Describes information about the `total` of a payment. ### listItem One of the selectable items in the `listItems` property of a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab. - `selected` (string, optional) — When **true,** indicates that this item is the default selection shown to a signer. Only one selection can be set as the default. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `text` (string, optional) — Specifies the text that is shown in the dropdown list. - `textMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value that is used when the list item is selected. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. ### graphicsContext - `fillColor` (string, optional) — 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](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). - `lineColor` (string, optional) — 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](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). - `lineWeight` (string, optional) — The line weight or thickness to use for the overlay. ### polyLine - `x1` (string, optional) - `x2` (string, optional) - `y1` (string, optional) - `y2` (string, optional) ### senderCompany - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### senderName - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### radio One of the selectable radio buttons in the `radios` property of a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `selected` (string, optional) — When **true,** the radio button is selected. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### stamp - `adoptedDateTime` (string, optional) — The UTC date and time when the user adopted the signature. - `createdDateTime` (string, optional) — The UTC DateTime when the item was created. - `customField` (string, optional) - `dateStampProperties` (dateStampProperties, optional) — Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. - `disallowUserResizeStamp` (string, optional) — When **true,** users may not resize the stamp. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `externalID` (string, optional) — Optionally specify an external identifier for the user's signature. - `imageBase64` (string, optional) - `imageType` (string, optional) — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image` - `lastModifiedDateTime` (string, optional) — The date and time that the item was last modified. - `phoneticName` (string, optional) — The phonetic spelling of the `signatureName`. - `signatureName` (string, optional) — Specifies the user's signature name. - `stampFormat` (string, optional) — The format of a stamp. Valid values are: - `NameHanko`: The stamp represents only the signer's name. - `NameDateHanko`: The stamp represents the signer's name and the date. - `stampImageUri` (string, optional) — The URI for retrieving the image of the user's stamp. - `stampSizeMM` (string, optional) — The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. ### smartSectionDisplaySettings These properties define how a Smart Section displays. A Smart Section is a type of display section. - `cellStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types. - `collapsibleSettings` (smartSectionCollapsibleDisplaySettings, optional) - `display` (string, optional) — Indicates the display type. Must be one of the following enum values: - **inline:** Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page. - **collapsible:** The HTML in the section may be expanded or collapsed. By default, the section is expanded. - **collapsed:** The HTML in the section may be expanded or collapsed. By default, the section is collapsed. - **responsive_table:** Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. - **responsive_table_single_column:** Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. The table is converted to a single column in which each column becomes a row and is stacked. - **print_only:** Prevents this portion of the HTML from displaying in the responsive signing view. - `displayLabel` (string, optional) — The label to add to this display section in the signing page. - `displayOrder` (integer, optional) — The position on the page where the display section appears. - `displayPageNumber` (integer, optional) — The number of the page on which the display section appears. - `hideLabelWhenOpened` (boolean, optional) — When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`. - `inlineOuterStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`. - `labelWhenOpened` (string, optional) — The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. - `preLabel` (string, optional) — Enables you to add descriptive text that appears before a collapsed section or continue button. - `scrollToTopWhenOpened` (boolean, optional) — When **true** and the section is expanded, the position of the section-close control scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. - `tableStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. ### smartSectionAnchorPosition - `pageNumber` (integer, optional) — Specifies the page number on which the tab is located. - `xPosition` (double, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPosition` (double, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. ### connectedData - `propertyName` (string, optional) — An identifier describing input data for a connected field. - `supportedOperation` (string, optional) — The type of operation used to verify a connected field. - `supportedUri` (string, optional) — The URI used to verify a connected field. - `typeName` (string, optional) — The name of the verification type used in a connected field. - `typeSystemNamespace` (string, optional) — The type of operation used during verification. ### connectionInstance - `connectionKey` (string, optional) — A key used to identify the connection instance of an extension app. - `connectionValue` (string, optional) — The GUID value that identifies the connection instance of an extension app. ### pathExtendedElement - `name` (string, optional) - `type` (string, optional) — The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` - `typeName` (string, optional) ### extendPaymentLineItem - `amountReference` (string, optional) - `description` (string, optional) - `name` (string, optional) - `priceId` (string, optional) - `productId` (string, optional) - `quantity` (string, optional) - `type` (string, optional) - `unitAmount` (string, optional) ### paymentLineItem A line item describes details about an individual line item in a payment request. - `amountReference` (string, optional) — This is a the `tabLabel` that specifies the amount paid for the line items. - `description` (string, optional) — A sender-defined description of the line item. - `itemCode` (string, optional) — This is the sender-defined SKU, inventory number, or other item code for the line item. - `name` (string, optional) — This is a sender-defined product name, service name, or other designation for the line item. ### paymentSignerValues - `paymentOption` (string, optional) — This property specifies how the signer's collected payment details will be used. Valid 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. ### money Describes information about the `total` of a payment. - `amountInBaseUnit` (string, optional) — The total payment amount in the currency's base unit. For example, for USD the base currency is one cent. - `currency` (string, optional) — The three-letter [ISO 4217](https://en.wikipedia.org/wiki/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. - `displayAmount` (string, optional) — 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. ### dateStampProperties Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. - `dateAreaHeight` (string, optional) — The height of the rectangle. - `dateAreaWidth` (string, optional) — The width of the rectangle. - `dateAreaX` (string, optional) — The X axis position of the top-left corner. - `dateAreaY` (string, optional) — The Y axis position of the top-left corner. ### smartSectionCollapsibleDisplaySettings - `arrowClosed` (string, optional) — Indicates the direction of the disclosure arrow when the collapsible section is in the closed state. One of the following: - `up`: In the closed state, the disclosure arrow points up. - `down`: In the closed state, the disclosure arrow points down. - `left`: In the closed state, the disclosure arrow points left. - `right`: In the closed state, the disclosure arrow points right. - `arrowColor` (string, optional) — A CSS color value (such as `#DCF851`) that indicates the color of the arrow. - `arrowLocation` (string, optional) — The location of the arrow relative to the collapsible section's label. Possible values are: - `right` (default) - `left` - `arrowOpen` (string, optional) — Indicates the direction of the disclosure arrow when the collapsible section is in the open state. One of the following: - `up`: In the open state, the disclosure arrow points up. - `down`: In the open state, the disclosure arrow points down. - `left`: In the open state, the disclosure arrow points left. - `right`: In the open state, the disclosure arrow points right. - `arrowSize` (string, optional) — Indicates the size of the collapsible arrows. Possible values are: - `small` - `large` (default) - `arrowStyle` (string, optional) — The name of the CSS style to be used on collapsible arrow section. - `containerStyle` (string, optional) — The name of the CSS style to be used for the collapsible container. - `labelStyle` (string, optional) — The name of the CSS style to be used for the collapsible container's label. - `onlyArrowIsClickable` (boolean, optional) — When **true,** only the arrow is clickable to expand or collapse the section. When **false** (the default), both the label and the arrow are clickable. If no arrow is used, this setting is ignored. - `outerLabelAndArrowStyle` (string, optional) — The name of the CSS style to be used for the collapsible container's outer label and arrow style. ## Examples **Request** ```json { "approveTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorAllowWhiteSpaceInCharactersMetadata": { "options": [ "sample string 1" ], "rights": "sample string 1" }, "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "buttonText": "sample string 15", "caption": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "connectedObjectDetails": { "recordId": "sample string 1" }, "customTabId": "sample string 19", "documentId": "sample string 20", "errorDetails": { "errorCode": "sample string 1", "message": "sample string 2" }, "extensionData": { "actionContract": "sample string 1", "actionInputKey": "sample string 2", "actionName": "sample string 3", "applicationId": "sample string 4", "applicationName": "sample string 5", "connectedFieldsData": { "propertyName": "sample string 1", "supportedOperation": "sample string 2", "supportedUri": "sample string 3", "typeName": "sample string 4", "typeSystemNamespace": "sample string 5" }, "connectionInstances": [ { "connectionKey": "sample string 1", "connectionValue": "sample string 2" } ], "extensionContract": "sample string 6", "extensionGroupId": "sample string 7", "extensionName": "sample string 8", "extensionPolicy": "sample string 9", "publisherName": "sample string 10", "requiredForExtension": "sample string 11" }, "font": "sample string 21", "fontColor": "sample string 22", "fontSize": "sample string 23", "formOrder": "sample string 24", "formPageLabel": "sample string 25", "formPageNumber": "sample string 26", "height": "sample string 27", "italic": "sample string 28", "localePolicy": { "addressFormat": "sample string 1", "calendarType": "sample string 2", "cultureName": "sample string 3", "currencyCode": "sample string 4", "currencyNegativeFormat": "sample string 5", "currencyPositiveFormat": "sample string 6", "customDateFormat": "sample string 7", "customTimeFormat": "sample string 8", "dateFormat": "sample string 9", "initialFormat": "sample string 10", "nameFormat": "sample string 11", "timeFormat": "sample string 12", "timeZone": "sample string 13", "useLongCurrencyFormat": "sample string 14" }, "mergeField": { "allowSenderToEdit": "sample string 1", "configurationType": "sample string 2", "path": "sample string 3", "pathExtended": [ { "name": "sample string 1", "type": "sample string 2", "typeName": "sample string 3" } ], "row": "sample string 4", "writeBack": "sample string 5" }, "mergeFieldXml": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "smartContractInformation": { "code": "sample string 1", "uri": "sample string 2" }, "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "width": "sample string 44", "xPosition": "sample string 45", "yPosition": "sample string 46" } ], "checkboxTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "locked": "sample string 28", "mergeFieldXml": "sample string 29", "name": "sample string 30", "pageNumber": "sample string 31", "recipientId": "sample string 32", "recipientIdGuid": "sample string 33", "required": "sample string 34", "requireInitialOnSharedChange": "sample string 35", "selected": "sample string 36", "selectedOriginal": "sample string 37", "shared": "sample string 38", "shareToRecipients": "sample string 39", "source": "sample string 40", "status": "sample string 41", "tabFullyQualifiedPath": "sample string 42", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 43", "tabLabel": "sample string 44", "tabOrder": "sample string 45", "tabType": "sample string 46", "templateLocked": "sample string 47", "templateRequired": "sample string 48", "tooltip": "sample string 49", "underline": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "commentThreadTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "comments": [ { "envelopeId": "sample string 1", "hmac": "sample string 2", "id": "sample string 3", "mentions": [ "sample string 1" ], "read": true, "sentByEmail": "sample string 4", "sentByFullName": "sample string 5", "sentByImageId": "sample string 6", "sentByInitials": "sample string 7", "sentByRecipientId": "sample string 8", "sentByUserId": "sample string 9", "signingGroupId": "sample string 10", "signingGroupName": "sample string 11", "subject": "sample string 12", "tabId": "sample string 13", "text": "sample string 14", "threadId": "sample string 15", "threadOriginatorId": "sample string 16", "timestamp": "sample string 17", "timeStampFormatted": "sample string 18", "visibleTo": [ "sample string 1" ] } ], "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "pageNumber": "sample string 29", "recipientId": "sample string 30", "recipientIdGuid": "sample string 31", "source": "sample string 32", "status": "sample string 33", "tabFullyQualifiedPath": "sample string 34", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 35", "tabLabel": "sample string 36", "tabOrder": "sample string 37", "tabType": "sample string 38", "templateLocked": "sample string 39", "templateRequired": "sample string 40", "threadId": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "width": "sample string 44", "xPosition": "sample string 45", "yPosition": "sample string 46" } ], "commissionCountyTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "commissionExpirationTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "commissionNumberTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "commissionStateTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "companyTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "dateSignedTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "timestampStandardized": "sample string 42", "tooltip": "sample string 43", "underline": "sample string 44", "value": "sample string 45", "width": "sample string 46", "xPosition": "sample string 47", "yPosition": "sample string 48" } ], "dateTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "requireAll": "sample string 38", "required": "sample string 39", "requireInitialOnSharedChange": "sample string 40", "senderRequired": "sample string 41", "shared": "sample string 42", "shareToRecipients": "sample string 43", "source": "sample string 44", "status": "sample string 45", "tabFullyQualifiedPath": "sample string 46", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 47", "tabLabel": "sample string 48", "tabOrder": "sample string 49", "tabType": "sample string 50", "templateLocked": "sample string 51", "templateRequired": "sample string 52", "tooltip": "sample string 53", "underline": "sample string 54", "validationMessage": "sample string 55", "validationPattern": "sample string 56", "value": "sample string 57", "width": "sample string 58", "xPosition": "sample string 59", "yPosition": "sample string 60" } ], "declineTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "buttonText": "sample string 15", "caption": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "declineReason": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "mergeFieldXml": "sample string 30", "pageNumber": "sample string 31", "recipientId": "sample string 32", "recipientIdGuid": "sample string 33", "source": "sample string 34", "status": "sample string 35", "tabFullyQualifiedPath": "sample string 36", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 37", "tabLabel": "sample string 38", "tabOrder": "sample string 39", "tabType": "sample string 40", "templateLocked": "sample string 41", "templateRequired": "sample string 42", "tooltip": "sample string 43", "underline": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "drawTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "allowSignerUpload": "sample string 3", "anchorAllowWhiteSpaceInCharacters": "sample string 4", "anchorCaseSensitive": "sample string 5", "anchorHorizontalAlignment": "sample string 6", "anchorIgnoreIfNotPresent": "sample string 7", "anchorMatchWholeWord": "sample string 8", "anchorString": "sample string 9", "anchorTabProcessorVersion": "sample string 10", "anchorTabScope": "sample string 11", "anchorUnits": "sample string 12", "anchorXOffset": "sample string 13", "anchorYOffset": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "formOrder": "sample string 20", "formPageLabel": "sample string 21", "formPageNumber": "sample string 22", "height": "sample string 23", "locked": "sample string 24", "mergeFieldXml": "sample string 25", "pageNumber": "sample string 26", "recipientId": "sample string 27", "recipientIdGuid": "sample string 28", "required": "sample string 29", "shared": "sample string 30", "source": "sample string 31", "status": "sample string 32", "tabFullyQualifiedPath": "sample string 33", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 34", "tabOrder": "sample string 35", "tabType": "sample string 36", "templateLocked": "sample string 37", "templateRequired": "sample string 38", "tooltip": "sample string 39", "useBackgroundAsCanvas": "sample string 40", "width": "sample string 41", "xPosition": "sample string 42", "yPosition": "sample string 43" } ], "emailAddressTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "emailTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "requireAll": "sample string 38", "required": "sample string 39", "requireInitialOnSharedChange": "sample string 40", "senderRequired": "sample string 41", "shared": "sample string 42", "shareToRecipients": "sample string 43", "source": "sample string 44", "status": "sample string 45", "tabFullyQualifiedPath": "sample string 46", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 47", "tabLabel": "sample string 48", "tabOrder": "sample string 49", "tabType": "sample string 50", "templateLocked": "sample string 51", "templateRequired": "sample string 52", "tooltip": "sample string 53", "underline": "sample string 54", "validationMessage": "sample string 55", "validationPattern": "sample string 56", "value": "sample string 57", "width": "sample string 58", "xPosition": "sample string 59", "yPosition": "sample string 60" } ], "envelopeIdTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "width": "sample string 44", "xPosition": "sample string 45", "yPosition": "sample string 46" } ], "firstNameTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "formulaTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "extendPaymentConfiguration": { "appId": "sample string 1", "connectionInstanceId": "sample string 2", "currency": "sample string 3", "durationEnd": "sample string 4", "durationStart": "sample string 5", "lineItems": [ { "amountReference": "sample string 1", "description": "sample string 2", "name": "sample string 3", "priceId": "sample string 4", "productId": "sample string 5", "quantity": "sample string 6", "type": "sample string 7", "unitAmount": "sample string 8" } ], "paymentDueDays": "sample string 6", "paymentMethods": [ "sample string 1" ], "paymentMode": "sample string 7", "tabRole": "sample string 8" }, "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "formula": "sample string 28", "height": "sample string 29", "hidden": "sample string 30", "isPaymentAmount": "sample string 31", "italic": "sample string 32", "locked": "sample string 33", "maxLength": "sample string 34", "mergeFieldXml": "sample string 35", "name": "sample string 36", "originalValue": "sample string 37", "pageNumber": "sample string 38", "paymentDetails": { "allowedPaymentMethods": [ "sample string 1" ], "chargeId": "sample string 1", "currencyCode": "sample string 2", "customerId": "sample string 3", "customMetadata": "sample string 4", "customMetadataRequired": true, "gatewayAccountId": "sample string 5", "gatewayDisplayName": "sample string 6", "gatewayName": "sample string 7", "lineItems": [ { "amountReference": "sample string 1", "description": "sample string 2", "itemCode": "sample string 3", "name": "sample string 4" } ], "paymentOption": "sample string 8", "paymentSourceId": "sample string 9", "signerValues": { "paymentOption": "sample string 1" }, "status": "sample string 10", "subGatewayName": "sample string 11", "total": { "amountInBaseUnit": "sample string 1", "currency": "sample string 2", "displayAmount": "sample string 3" } }, "recipientId": "sample string 39", "recipientIdGuid": "sample string 40", "requireAll": "sample string 41", "required": "sample string 42", "requireInitialOnSharedChange": "sample string 43", "roundDecimalPlaces": "sample string 44", "senderRequired": "sample string 45", "shared": "sample string 46", "shareToRecipients": "sample string 47", "source": "sample string 48", "status": "sample string 49", "tabFullyQualifiedPath": "sample string 50", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 51", "tabLabel": "sample string 52", "tabOrder": "sample string 53", "tabType": "sample string 54", "templateLocked": "sample string 55", "templateRequired": "sample string 56", "tooltip": "sample string 57", "underline": "sample string 58", "validationMessage": "sample string 59", "validationPattern": "sample string 60", "value": "sample string 61", "width": "sample string 62", "xPosition": "sample string 63", "yPosition": "sample string 64" } ], "fullNameTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "initialHereTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "handDrawRequired": "sample string 22", "height": "sample string 23", "mergeFieldXml": "sample string 24", "name": "sample string 25", "optional": "sample string 26", "pageNumber": "sample string 27", "recipientId": "sample string 28", "recipientIdGuid": "sample string 29", "scaleValue": "sample string 30", "source": "sample string 31", "status": "sample string 32", "tabFullyQualifiedPath": "sample string 33", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 34", "tabLabel": "sample string 35", "tabOrder": "sample string 36", "tabType": "sample string 37", "templateLocked": "sample string 38", "templateRequired": "sample string 39", "tooltip": "sample string 40", "width": "sample string 41", "xPosition": "sample string 42", "yPosition": "sample string 43" } ], "lastNameTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "listTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "listItems": [ { "selected": "sample string 1", "text": "sample string 2", "value": "sample string 3" } ], "listSelectedValue": "sample string 28", "locked": "sample string 29", "mergeFieldXml": "sample string 30", "originalValue": "sample string 31", "pageNumber": "sample string 32", "recipientId": "sample string 33", "recipientIdGuid": "sample string 34", "requireAll": "sample string 35", "required": "sample string 36", "requireInitialOnSharedChange": "sample string 37", "senderRequired": "sample string 38", "shared": "sample string 39", "shareToRecipients": "sample string 40", "source": "sample string 41", "status": "sample string 42", "tabFullyQualifiedPath": "sample string 43", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 44", "tabLabel": "sample string 45", "tabOrder": "sample string 46", "tabType": "sample string 47", "templateLocked": "sample string 48", "templateRequired": "sample string 49", "tooltip": "sample string 50", "underline": "sample string 51", "value": "sample string 52", "width": "sample string 53", "xPosition": "sample string 54", "yPosition": "sample string 55" } ], "notarizeTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "height": "sample string 22", "locked": "sample string 23", "mergeFieldXml": "sample string 24", "pageNumber": "sample string 25", "recipientId": "sample string 26", "recipientIdGuid": "sample string 27", "required": "sample string 28", "source": "sample string 29", "status": "sample string 30", "tabFullyQualifiedPath": "sample string 31", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 32", "tabOrder": "sample string 33", "tabType": "sample string 34", "templateLocked": "sample string 35", "templateRequired": "sample string 36", "tooltip": "sample string 37", "width": "sample string 38", "xPosition": "sample string 39", "yPosition": "sample string 40" } ], "notarySealTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "height": "sample string 22", "mergeFieldXml": "sample string 23", "name": "sample string 24", "pageNumber": "sample string 25", "recipientId": "sample string 26", "recipientIdGuid": "sample string 27", "scaleValue": "sample string 28", "source": "sample string 29", "status": "sample string 30", "tabFullyQualifiedPath": "sample string 31", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 32", "tabLabel": "sample string 33", "tabOrder": "sample string 34", "tabType": "sample string 35", "templateLocked": "sample string 36", "templateRequired": "sample string 37", "tooltip": "sample string 38", "width": "sample string 39", "xPosition": "sample string 40", "yPosition": "sample string 41" } ], "noteTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "shared": "sample string 33", "source": "sample string 34", "status": "sample string 35", "tabFullyQualifiedPath": "sample string 36", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 37", "tabLabel": "sample string 38", "tabOrder": "sample string 39", "tabType": "sample string 40", "templateLocked": "sample string 41", "templateRequired": "sample string 42", "tooltip": "sample string 43", "underline": "sample string 44", "value": "sample string 45", "width": "sample string 46", "xPosition": "sample string 47", "yPosition": "sample string 48" } ], "numberTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "formula": "sample string 28", "height": "sample string 29", "isPaymentAmount": "sample string 30", "italic": "sample string 31", "locked": "sample string 32", "maxLength": "sample string 33", "mergeFieldXml": "sample string 34", "name": "sample string 35", "originalValue": "sample string 36", "pageNumber": "sample string 37", "recipientId": "sample string 38", "recipientIdGuid": "sample string 39", "requireAll": "sample string 40", "required": "sample string 41", "requireInitialOnSharedChange": "sample string 42", "senderRequired": "sample string 43", "shared": "sample string 44", "shareToRecipients": "sample string 45", "source": "sample string 46", "status": "sample string 47", "tabFullyQualifiedPath": "sample string 48", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 49", "tabLabel": "sample string 50", "tabOrder": "sample string 51", "tabType": "sample string 52", "templateLocked": "sample string 53", "templateRequired": "sample string 54", "tooltip": "sample string 55", "underline": "sample string 56", "validationMessage": "sample string 57", "validationPattern": "sample string 58", "value": "sample string 59", "width": "sample string 60", "xPosition": "sample string 61", "yPosition": "sample string 62" } ], "numericalTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "maxNumericalValue": "sample string 32", "mergeFieldXml": "sample string 33", "minNumericalValue": "sample string 34", "name": "sample string 35", "numericalValue": "sample string 36", "originalNumericalValue": "sample string 37", "originalValue": "sample string 38", "pageNumber": "sample string 39", "recipientId": "sample string 40", "recipientIdGuid": "sample string 41", "requireAll": "sample string 42", "required": "sample string 43", "requireInitialOnSharedChange": "sample string 44", "senderRequired": "sample string 45", "shared": "sample string 46", "shareToRecipients": "sample string 47", "source": "sample string 48", "status": "sample string 49", "tabFullyQualifiedPath": "sample string 50", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 51", "tabLabel": "sample string 52", "tabOrder": "sample string 53", "tabType": "sample string 54", "templateLocked": "sample string 55", "templateRequired": "sample string 56", "tooltip": "sample string 57", "underline": "sample string 58", "validationType": "sample string 59", "value": "sample string 60", "width": "sample string 61", "xPosition": "sample string 62", "yPosition": "sample string 63" } ], "phoneNumberTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "polyLineOverlayTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "graphicsContext": { "fillColor": "sample string 1", "lineColor": "sample string 2", "lineWeight": "sample string 3" }, "height": "sample string 22", "locked": "sample string 23", "mergeFieldXml": "sample string 24", "overlayType": "sample string 25", "pageNumber": "sample string 26", "polyLines": [ { "x1": "sample string 1", "x2": "sample string 2", "y1": "sample string 3", "y2": "sample string 4" } ], "recipientId": "sample string 27", "recipientIdGuid": "sample string 28", "shared": "sample string 29", "source": "sample string 30", "status": "sample string 31", "tabFullyQualifiedPath": "sample string 32", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 33", "tabLabel": "sample string 34", "tabOrder": "sample string 35", "tabType": "sample string 36", "templateLocked": "sample string 37", "templateRequired": "sample string 38", "tooltip": "sample string 39", "width": "sample string 40", "xPosition": "sample string 41", "yPosition": "sample string 42" } ], "prefillTabs": { "checkboxTabs": [ {} ], "dateTabs": [ {} ], "emailTabs": [ {} ], "numberTabs": [ {} ], "radioGroupTabs": [ { "conditionalParentLabel": "sample string 1", "conditionalParentValue": "sample string 2", "documentId": "sample string 3", "groupName": "sample string 4", "originalValue": "sample string 5", "radios": [ { "anchorAllowWhiteSpaceInCharacters": "sample string 1", "anchorCaseSensitive": "sample string 2", "anchorHorizontalAlignment": "sample string 3", "anchorIgnoreIfNotPresent": "sample string 4", "anchorMatchWholeWord": "sample string 5", "anchorString": "sample string 6", "anchorTabProcessorVersion": "sample string 7", "anchorTabScope": "sample string 8", "anchorUnits": "sample string 9", "anchorXOffset": "sample string 10", "anchorYOffset": "sample string 11", "bold": "sample string 12", "caption": "sample string 13", "font": "sample string 14", "fontColor": "sample string 15", "fontSize": "sample string 16", "italic": "sample string 17", "locked": "sample string 18", "mergeFieldXml": "sample string 19", "pageNumber": "sample string 20", "required": "sample string 21", "selected": "sample string 22", "status": "sample string 23", "tabFullyQualifiedPath": "sample string 24", "tabId": "sample string 25", "tabOrder": "sample string 26", "underline": "sample string 27", "value": "sample string 28", "xPosition": "sample string 29", "yPosition": "sample string 30" } ], "recipientId": "sample string 6", "recipientIdGuid": "sample string 7", "requireAll": "sample string 8", "requireInitialOnSharedChange": "sample string 9", "shared": "sample string 10", "shareToRecipients": "sample string 11", "source": "sample string 12", "tabType": "sample string 13", "templateLocked": "sample string 14", "templateRequired": "sample string 15", "tooltip": "sample string 16", "value": "sample string 17" } ], "senderCompanyTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "senderNameTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "ssnTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "requireAll": "sample string 38", "required": "sample string 39", "requireInitialOnSharedChange": "sample string 40", "senderRequired": "sample string 41", "shared": "sample string 42", "shareToRecipients": "sample string 43", "source": "sample string 44", "status": "sample string 45", "tabFullyQualifiedPath": "sample string 46", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 47", "tabLabel": "sample string 48", "tabOrder": "sample string 49", "tabType": "sample string 50", "templateLocked": "sample string 51", "templateRequired": "sample string 52", "tooltip": "sample string 53", "underline": "sample string 54", "validationMessage": "sample string 55", "validationPattern": "sample string 56", "value": "sample string 57", "width": "sample string 58", "xPosition": "sample string 59", "yPosition": "sample string 60" } ], "tabGroups": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "groupLabel": "sample string 22", "groupRule": "sample string 23", "height": "sample string 24", "maximumAllowed": "sample string 25", "mergeFieldXml": "sample string 26", "minimumRequired": "sample string 27", "pageNumber": "sample string 28", "recipientId": "sample string 29", "recipientIdGuid": "sample string 30", "source": "sample string 31", "status": "sample string 32", "tabFullyQualifiedPath": "sample string 33", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 34", "tabOrder": "sample string 35", "tabScope": "sample string 36", "tabType": "sample string 37", "templateLocked": "sample string 38", "templateRequired": "sample string 39", "tooltip": "sample string 40", "validationMessage": "sample string 41", "width": "sample string 42", "xPosition": "sample string 43", "yPosition": "sample string 44" } ], "textTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "formula": "sample string 28", "height": "sample string 29", "isPaymentAmount": "sample string 30", "italic": "sample string 31", "locked": "sample string 32", "maxLength": "sample string 33", "mergeFieldXml": "sample string 34", "name": "sample string 35", "originalValue": "sample string 36", "pageNumber": "sample string 37", "recipientId": "sample string 38", "recipientIdGuid": "sample string 39", "requireAll": "sample string 40", "required": "sample string 41", "requireInitialOnSharedChange": "sample string 42", "senderRequired": "sample string 43", "shared": "sample string 44", "shareToRecipients": "sample string 45", "source": "sample string 46", "status": "sample string 47", "tabFullyQualifiedPath": "sample string 48", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 49", "tabLabel": "sample string 50", "tabOrder": "sample string 51", "tabType": "sample string 52", "templateLocked": "sample string 53", "templateRequired": "sample string 54", "tooltip": "sample string 55", "underline": "sample string 56", "validationMessage": "sample string 57", "validationPattern": "sample string 58", "value": "sample string 59", "width": "sample string 60", "xPosition": "sample string 61", "yPosition": "sample string 62" } ], "zipTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "requireAll": "sample string 38", "required": "sample string 39", "requireInitialOnSharedChange": "sample string 40", "senderRequired": "sample string 41", "shared": "sample string 42", "shareToRecipients": "sample string 43", "source": "sample string 44", "status": "sample string 45", "tabFullyQualifiedPath": "sample string 46", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 47", "tabLabel": "sample string 48", "tabOrder": "sample string 49", "tabType": "sample string 50", "templateLocked": "sample string 51", "templateRequired": "sample string 52", "tooltip": "sample string 53", "underline": "sample string 54", "useDash4": "sample string 55", "validationMessage": "sample string 56", "validationPattern": "sample string 57", "value": "sample string 58", "width": "sample string 59", "xPosition": "sample string 60", "yPosition": "sample string 61" } ] }, "radioGroupTabs": [ {} ], "signerAttachmentTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "handDrawRequired": "sample string 22", "height": "sample string 23", "mergeFieldXml": "sample string 24", "name": "sample string 25", "optional": "sample string 26", "pageNumber": "sample string 27", "recipientId": "sample string 28", "recipientIdGuid": "sample string 29", "scaleValue": "sample string 30", "source": "sample string 31", "status": "sample string 32", "tabFullyQualifiedPath": "sample string 33", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 34", "tabLabel": "sample string 35", "tabOrder": "sample string 36", "tabType": "sample string 37", "templateLocked": "sample string 38", "templateRequired": "sample string 39", "tooltip": "sample string 40", "width": "sample string 41", "xPosition": "sample string 42", "yPosition": "sample string 43" } ], "signHereTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "handDrawRequired": "sample string 22", "height": "sample string 23", "isSealSignTab": "sample string 24", "mergeFieldXml": "sample string 25", "name": "sample string 26", "optional": "sample string 27", "pageNumber": "sample string 28", "recipientId": "sample string 29", "recipientIdGuid": "sample string 30", "scaleValue": "sample string 31", "source": "sample string 32", "stamp": { "adoptedDateTime": "sample string 1", "createdDateTime": "sample string 2", "customField": "sample string 3", "dateStampProperties": { "dateAreaHeight": "sample string 1", "dateAreaWidth": "sample string 2", "dateAreaX": "sample string 3", "dateAreaY": "sample string 4" }, "disallowUserResizeStamp": "sample string 4", "externalID": "sample string 5", "imageBase64": "sample string 6", "imageType": "sample string 7", "lastModifiedDateTime": "sample string 8", "phoneticName": "sample string 9", "signatureName": "sample string 10", "stampFormat": "sample string 11", "stampImageUri": "sample string 12", "stampSizeMM": "sample string 13", "status": "sample string 14" }, "stampType": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "width": "sample string 43", "xPosition": "sample string 44", "yPosition": "sample string 45" } ], "smartSectionTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "caseSensitive": true, "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "displaySettings": { "cellStyle": "sample string 1", "collapsibleSettings": { "arrowClosed": "sample string 1", "arrowColor": "sample string 2", "arrowLocation": "sample string 3", "arrowOpen": "sample string 4", "arrowSize": "sample string 5", "arrowStyle": "sample string 6", "containerStyle": "sample string 7", "labelStyle": "sample string 8", "onlyArrowIsClickable": true, "outerLabelAndArrowStyle": "sample string 9" }, "display": "sample string 2", "displayLabel": "sample string 3", "displayOrder": 4, "displayPageNumber": 5, "hideLabelWhenOpened": true, "inlineOuterStyle": "sample string 6", "labelWhenOpened": "sample string 7", "preLabel": "sample string 8", "scrollToTopWhenOpened": true, "tableStyle": "sample string 9" }, "documentId": "sample string 18", "endAnchor": "sample string 19", "endPosition": { "pageNumber": 1, "xPosition": 1.1, "yPosition": 1.1 }, "formOrder": "sample string 20", "formPageLabel": "sample string 21", "formPageNumber": "sample string 22", "height": "sample string 23", "locked": "sample string 24", "mergeFieldXml": "sample string 25", "overlayType": "sample string 26", "pageNumber": "sample string 27", "recipientId": "sample string 28", "recipientIdGuid": "sample string 29", "removeEndAnchor": true, "removeStartAnchor": true, "shared": "sample string 30", "source": "sample string 31", "startAnchor": "sample string 32", "status": "sample string 33", "tabFullyQualifiedPath": "sample string 34", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 35", "tabLabel": "sample string 36", "tabOrder": "sample string 37", "tabType": "sample string 38", "templateLocked": "sample string 39", "templateRequired": "sample string 40", "tooltip": "sample string 41", "width": "sample string 42", "xPosition": "sample string 43", "yPosition": "sample string 44" } ], "ssnTabs": [ {} ], "tabGroups": [ {} ], "textTabs": [ {} ], "titleTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "viewTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "buttonText": "sample string 15", "caption": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "documentId": "sample string 20", "font": "sample string 21", "fontColor": "sample string 22", "fontSize": "sample string 23", "formOrder": "sample string 24", "formPageLabel": "sample string 25", "formPageNumber": "sample string 26", "height": "sample string 27", "italic": "sample string 28", "mergeFieldXml": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "required": "sample string 33", "requiredRead": "sample string 34", "source": "sample string 35", "status": "sample string 36", "tabFullyQualifiedPath": "sample string 37", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 38", "tabLabel": "sample string 39", "tabOrder": "sample string 40", "tabType": "sample string 41", "templateLocked": "sample string 42", "templateRequired": "sample string 43", "tooltip": "sample string 44", "underline": "sample string 45", "width": "sample string 46", "xPosition": "sample string 47", "yPosition": "sample string 48" } ], "zipTabs": [ {} ] } ``` **Response** ```json { "approveTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorAllowWhiteSpaceInCharactersMetadata": { "options": [ "sample string 1" ], "rights": "sample string 1" }, "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "buttonText": "sample string 15", "caption": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "connectedObjectDetails": { "recordId": "sample string 1" }, "customTabId": "sample string 19", "documentId": "sample string 20", "errorDetails": { "errorCode": "sample string 1", "message": "sample string 2" }, "extensionData": { "actionContract": "sample string 1", "actionInputKey": "sample string 2", "actionName": "sample string 3", "applicationId": "sample string 4", "applicationName": "sample string 5", "connectedFieldsData": { "propertyName": "sample string 1", "supportedOperation": "sample string 2", "supportedUri": "sample string 3", "typeName": "sample string 4", "typeSystemNamespace": "sample string 5" }, "connectionInstances": [ { "connectionKey": "sample string 1", "connectionValue": "sample string 2" } ], "extensionContract": "sample string 6", "extensionGroupId": "sample string 7", "extensionName": "sample string 8", "extensionPolicy": "sample string 9", "publisherName": "sample string 10", "requiredForExtension": "sample string 11" }, "font": "sample string 21", "fontColor": "sample string 22", "fontSize": "sample string 23", "formOrder": "sample string 24", "formPageLabel": "sample string 25", "formPageNumber": "sample string 26", "height": "sample string 27", "italic": "sample string 28", "localePolicy": { "addressFormat": "sample string 1", "calendarType": "sample string 2", "cultureName": "sample string 3", "currencyCode": "sample string 4", "currencyNegativeFormat": "sample string 5", "currencyPositiveFormat": "sample string 6", "customDateFormat": "sample string 7", "customTimeFormat": "sample string 8", "dateFormat": "sample string 9", "initialFormat": "sample string 10", "nameFormat": "sample string 11", "timeFormat": "sample string 12", "timeZone": "sample string 13", "useLongCurrencyFormat": "sample string 14" }, "mergeField": { "allowSenderToEdit": "sample string 1", "configurationType": "sample string 2", "path": "sample string 3", "pathExtended": [ { "name": "sample string 1", "type": "sample string 2", "typeName": "sample string 3" } ], "row": "sample string 4", "writeBack": "sample string 5" }, "mergeFieldXml": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "smartContractInformation": { "code": "sample string 1", "uri": "sample string 2" }, "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "width": "sample string 44", "xPosition": "sample string 45", "yPosition": "sample string 46" } ], "checkboxTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "locked": "sample string 28", "mergeFieldXml": "sample string 29", "name": "sample string 30", "pageNumber": "sample string 31", "recipientId": "sample string 32", "recipientIdGuid": "sample string 33", "required": "sample string 34", "requireInitialOnSharedChange": "sample string 35", "selected": "sample string 36", "selectedOriginal": "sample string 37", "shared": "sample string 38", "shareToRecipients": "sample string 39", "source": "sample string 40", "status": "sample string 41", "tabFullyQualifiedPath": "sample string 42", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 43", "tabLabel": "sample string 44", "tabOrder": "sample string 45", "tabType": "sample string 46", "templateLocked": "sample string 47", "templateRequired": "sample string 48", "tooltip": "sample string 49", "underline": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "commentThreadTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "comments": [ { "envelopeId": "sample string 1", "hmac": "sample string 2", "id": "sample string 3", "mentions": [ "sample string 1" ], "read": true, "sentByEmail": "sample string 4", "sentByFullName": "sample string 5", "sentByImageId": "sample string 6", "sentByInitials": "sample string 7", "sentByRecipientId": "sample string 8", "sentByUserId": "sample string 9", "signingGroupId": "sample string 10", "signingGroupName": "sample string 11", "subject": "sample string 12", "tabId": "sample string 13", "text": "sample string 14", "threadId": "sample string 15", "threadOriginatorId": "sample string 16", "timestamp": "sample string 17", "timeStampFormatted": "sample string 18", "visibleTo": [ "sample string 1" ] } ], "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "pageNumber": "sample string 29", "recipientId": "sample string 30", "recipientIdGuid": "sample string 31", "source": "sample string 32", "status": "sample string 33", "tabFullyQualifiedPath": "sample string 34", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 35", "tabLabel": "sample string 36", "tabOrder": "sample string 37", "tabType": "sample string 38", "templateLocked": "sample string 39", "templateRequired": "sample string 40", "threadId": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "width": "sample string 44", "xPosition": "sample string 45", "yPosition": "sample string 46" } ], "commissionCountyTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "commissionExpirationTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "commissionNumberTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "commissionStateTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "companyTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "dateSignedTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "timestampStandardized": "sample string 42", "tooltip": "sample string 43", "underline": "sample string 44", "value": "sample string 45", "width": "sample string 46", "xPosition": "sample string 47", "yPosition": "sample string 48" } ], "dateTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "requireAll": "sample string 38", "required": "sample string 39", "requireInitialOnSharedChange": "sample string 40", "senderRequired": "sample string 41", "shared": "sample string 42", "shareToRecipients": "sample string 43", "source": "sample string 44", "status": "sample string 45", "tabFullyQualifiedPath": "sample string 46", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 47", "tabLabel": "sample string 48", "tabOrder": "sample string 49", "tabType": "sample string 50", "templateLocked": "sample string 51", "templateRequired": "sample string 52", "tooltip": "sample string 53", "underline": "sample string 54", "validationMessage": "sample string 55", "validationPattern": "sample string 56", "value": "sample string 57", "width": "sample string 58", "xPosition": "sample string 59", "yPosition": "sample string 60" } ], "declineTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "buttonText": "sample string 15", "caption": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "declineReason": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "mergeFieldXml": "sample string 30", "pageNumber": "sample string 31", "recipientId": "sample string 32", "recipientIdGuid": "sample string 33", "source": "sample string 34", "status": "sample string 35", "tabFullyQualifiedPath": "sample string 36", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 37", "tabLabel": "sample string 38", "tabOrder": "sample string 39", "tabType": "sample string 40", "templateLocked": "sample string 41", "templateRequired": "sample string 42", "tooltip": "sample string 43", "underline": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "drawTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "allowSignerUpload": "sample string 3", "anchorAllowWhiteSpaceInCharacters": "sample string 4", "anchorCaseSensitive": "sample string 5", "anchorHorizontalAlignment": "sample string 6", "anchorIgnoreIfNotPresent": "sample string 7", "anchorMatchWholeWord": "sample string 8", "anchorString": "sample string 9", "anchorTabProcessorVersion": "sample string 10", "anchorTabScope": "sample string 11", "anchorUnits": "sample string 12", "anchorXOffset": "sample string 13", "anchorYOffset": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "formOrder": "sample string 20", "formPageLabel": "sample string 21", "formPageNumber": "sample string 22", "height": "sample string 23", "locked": "sample string 24", "mergeFieldXml": "sample string 25", "pageNumber": "sample string 26", "recipientId": "sample string 27", "recipientIdGuid": "sample string 28", "required": "sample string 29", "shared": "sample string 30", "source": "sample string 31", "status": "sample string 32", "tabFullyQualifiedPath": "sample string 33", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 34", "tabOrder": "sample string 35", "tabType": "sample string 36", "templateLocked": "sample string 37", "templateRequired": "sample string 38", "tooltip": "sample string 39", "useBackgroundAsCanvas": "sample string 40", "width": "sample string 41", "xPosition": "sample string 42", "yPosition": "sample string 43" } ], "emailAddressTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "emailTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "requireAll": "sample string 38", "required": "sample string 39", "requireInitialOnSharedChange": "sample string 40", "senderRequired": "sample string 41", "shared": "sample string 42", "shareToRecipients": "sample string 43", "source": "sample string 44", "status": "sample string 45", "tabFullyQualifiedPath": "sample string 46", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 47", "tabLabel": "sample string 48", "tabOrder": "sample string 49", "tabType": "sample string 50", "templateLocked": "sample string 51", "templateRequired": "sample string 52", "tooltip": "sample string 53", "underline": "sample string 54", "validationMessage": "sample string 55", "validationPattern": "sample string 56", "value": "sample string 57", "width": "sample string 58", "xPosition": "sample string 59", "yPosition": "sample string 60" } ], "envelopeIdTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "width": "sample string 44", "xPosition": "sample string 45", "yPosition": "sample string 46" } ], "firstNameTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "formulaTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "extendPaymentConfiguration": { "appId": "sample string 1", "connectionInstanceId": "sample string 2", "currency": "sample string 3", "durationEnd": "sample string 4", "durationStart": "sample string 5", "lineItems": [ { "amountReference": "sample string 1", "description": "sample string 2", "name": "sample string 3", "priceId": "sample string 4", "productId": "sample string 5", "quantity": "sample string 6", "type": "sample string 7", "unitAmount": "sample string 8" } ], "paymentDueDays": "sample string 6", "paymentMethods": [ "sample string 1" ], "paymentMode": "sample string 7", "tabRole": "sample string 8" }, "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "formula": "sample string 28", "height": "sample string 29", "hidden": "sample string 30", "isPaymentAmount": "sample string 31", "italic": "sample string 32", "locked": "sample string 33", "maxLength": "sample string 34", "mergeFieldXml": "sample string 35", "name": "sample string 36", "originalValue": "sample string 37", "pageNumber": "sample string 38", "paymentDetails": { "allowedPaymentMethods": [ "sample string 1" ], "chargeId": "sample string 1", "currencyCode": "sample string 2", "customerId": "sample string 3", "customMetadata": "sample string 4", "customMetadataRequired": true, "gatewayAccountId": "sample string 5", "gatewayDisplayName": "sample string 6", "gatewayName": "sample string 7", "lineItems": [ { "amountReference": "sample string 1", "description": "sample string 2", "itemCode": "sample string 3", "name": "sample string 4" } ], "paymentOption": "sample string 8", "paymentSourceId": "sample string 9", "signerValues": { "paymentOption": "sample string 1" }, "status": "sample string 10", "subGatewayName": "sample string 11", "total": { "amountInBaseUnit": "sample string 1", "currency": "sample string 2", "displayAmount": "sample string 3" } }, "recipientId": "sample string 39", "recipientIdGuid": "sample string 40", "requireAll": "sample string 41", "required": "sample string 42", "requireInitialOnSharedChange": "sample string 43", "roundDecimalPlaces": "sample string 44", "senderRequired": "sample string 45", "shared": "sample string 46", "shareToRecipients": "sample string 47", "source": "sample string 48", "status": "sample string 49", "tabFullyQualifiedPath": "sample string 50", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 51", "tabLabel": "sample string 52", "tabOrder": "sample string 53", "tabType": "sample string 54", "templateLocked": "sample string 55", "templateRequired": "sample string 56", "tooltip": "sample string 57", "underline": "sample string 58", "validationMessage": "sample string 59", "validationPattern": "sample string 60", "value": "sample string 61", "width": "sample string 62", "xPosition": "sample string 63", "yPosition": "sample string 64" } ], "fullNameTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "initialHereTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "handDrawRequired": "sample string 22", "height": "sample string 23", "mergeFieldXml": "sample string 24", "name": "sample string 25", "optional": "sample string 26", "pageNumber": "sample string 27", "recipientId": "sample string 28", "recipientIdGuid": "sample string 29", "scaleValue": "sample string 30", "source": "sample string 31", "status": "sample string 32", "tabFullyQualifiedPath": "sample string 33", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 34", "tabLabel": "sample string 35", "tabOrder": "sample string 36", "tabType": "sample string 37", "templateLocked": "sample string 38", "templateRequired": "sample string 39", "tooltip": "sample string 40", "width": "sample string 41", "xPosition": "sample string 42", "yPosition": "sample string 43" } ], "lastNameTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "listTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "listItems": [ { "selected": "sample string 1", "text": "sample string 2", "value": "sample string 3" } ], "listSelectedValue": "sample string 28", "locked": "sample string 29", "mergeFieldXml": "sample string 30", "originalValue": "sample string 31", "pageNumber": "sample string 32", "recipientId": "sample string 33", "recipientIdGuid": "sample string 34", "requireAll": "sample string 35", "required": "sample string 36", "requireInitialOnSharedChange": "sample string 37", "senderRequired": "sample string 38", "shared": "sample string 39", "shareToRecipients": "sample string 40", "source": "sample string 41", "status": "sample string 42", "tabFullyQualifiedPath": "sample string 43", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 44", "tabLabel": "sample string 45", "tabOrder": "sample string 46", "tabType": "sample string 47", "templateLocked": "sample string 48", "templateRequired": "sample string 49", "tooltip": "sample string 50", "underline": "sample string 51", "value": "sample string 52", "width": "sample string 53", "xPosition": "sample string 54", "yPosition": "sample string 55" } ], "notarizeTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "height": "sample string 22", "locked": "sample string 23", "mergeFieldXml": "sample string 24", "pageNumber": "sample string 25", "recipientId": "sample string 26", "recipientIdGuid": "sample string 27", "required": "sample string 28", "source": "sample string 29", "status": "sample string 30", "tabFullyQualifiedPath": "sample string 31", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 32", "tabOrder": "sample string 33", "tabType": "sample string 34", "templateLocked": "sample string 35", "templateRequired": "sample string 36", "tooltip": "sample string 37", "width": "sample string 38", "xPosition": "sample string 39", "yPosition": "sample string 40" } ], "notarySealTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "height": "sample string 22", "mergeFieldXml": "sample string 23", "name": "sample string 24", "pageNumber": "sample string 25", "recipientId": "sample string 26", "recipientIdGuid": "sample string 27", "scaleValue": "sample string 28", "source": "sample string 29", "status": "sample string 30", "tabFullyQualifiedPath": "sample string 31", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 32", "tabLabel": "sample string 33", "tabOrder": "sample string 34", "tabType": "sample string 35", "templateLocked": "sample string 36", "templateRequired": "sample string 37", "tooltip": "sample string 38", "width": "sample string 39", "xPosition": "sample string 40", "yPosition": "sample string 41" } ], "noteTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "shared": "sample string 33", "source": "sample string 34", "status": "sample string 35", "tabFullyQualifiedPath": "sample string 36", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 37", "tabLabel": "sample string 38", "tabOrder": "sample string 39", "tabType": "sample string 40", "templateLocked": "sample string 41", "templateRequired": "sample string 42", "tooltip": "sample string 43", "underline": "sample string 44", "value": "sample string 45", "width": "sample string 46", "xPosition": "sample string 47", "yPosition": "sample string 48" } ], "numberTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "formula": "sample string 28", "height": "sample string 29", "isPaymentAmount": "sample string 30", "italic": "sample string 31", "locked": "sample string 32", "maxLength": "sample string 33", "mergeFieldXml": "sample string 34", "name": "sample string 35", "originalValue": "sample string 36", "pageNumber": "sample string 37", "recipientId": "sample string 38", "recipientIdGuid": "sample string 39", "requireAll": "sample string 40", "required": "sample string 41", "requireInitialOnSharedChange": "sample string 42", "senderRequired": "sample string 43", "shared": "sample string 44", "shareToRecipients": "sample string 45", "source": "sample string 46", "status": "sample string 47", "tabFullyQualifiedPath": "sample string 48", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 49", "tabLabel": "sample string 50", "tabOrder": "sample string 51", "tabType": "sample string 52", "templateLocked": "sample string 53", "templateRequired": "sample string 54", "tooltip": "sample string 55", "underline": "sample string 56", "validationMessage": "sample string 57", "validationPattern": "sample string 58", "value": "sample string 59", "width": "sample string 60", "xPosition": "sample string 61", "yPosition": "sample string 62" } ], "numericalTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "maxNumericalValue": "sample string 32", "mergeFieldXml": "sample string 33", "minNumericalValue": "sample string 34", "name": "sample string 35", "numericalValue": "sample string 36", "originalNumericalValue": "sample string 37", "originalValue": "sample string 38", "pageNumber": "sample string 39", "recipientId": "sample string 40", "recipientIdGuid": "sample string 41", "requireAll": "sample string 42", "required": "sample string 43", "requireInitialOnSharedChange": "sample string 44", "senderRequired": "sample string 45", "shared": "sample string 46", "shareToRecipients": "sample string 47", "source": "sample string 48", "status": "sample string 49", "tabFullyQualifiedPath": "sample string 50", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 51", "tabLabel": "sample string 52", "tabOrder": "sample string 53", "tabType": "sample string 54", "templateLocked": "sample string 55", "templateRequired": "sample string 56", "tooltip": "sample string 57", "underline": "sample string 58", "validationType": "sample string 59", "value": "sample string 60", "width": "sample string 61", "xPosition": "sample string 62", "yPosition": "sample string 63" } ], "phoneNumberTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "polyLineOverlayTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "graphicsContext": { "fillColor": "sample string 1", "lineColor": "sample string 2", "lineWeight": "sample string 3" }, "height": "sample string 22", "locked": "sample string 23", "mergeFieldXml": "sample string 24", "overlayType": "sample string 25", "pageNumber": "sample string 26", "polyLines": [ { "x1": "sample string 1", "x2": "sample string 2", "y1": "sample string 3", "y2": "sample string 4" } ], "recipientId": "sample string 27", "recipientIdGuid": "sample string 28", "shared": "sample string 29", "source": "sample string 30", "status": "sample string 31", "tabFullyQualifiedPath": "sample string 32", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 33", "tabLabel": "sample string 34", "tabOrder": "sample string 35", "tabType": "sample string 36", "templateLocked": "sample string 37", "templateRequired": "sample string 38", "tooltip": "sample string 39", "width": "sample string 40", "xPosition": "sample string 41", "yPosition": "sample string 42" } ], "prefillTabs": { "checkboxTabs": [ {} ], "dateTabs": [ {} ], "emailTabs": [ {} ], "numberTabs": [ {} ], "radioGroupTabs": [ { "conditionalParentLabel": "sample string 1", "conditionalParentValue": "sample string 2", "documentId": "sample string 3", "groupName": "sample string 4", "originalValue": "sample string 5", "radios": [ { "anchorAllowWhiteSpaceInCharacters": "sample string 1", "anchorCaseSensitive": "sample string 2", "anchorHorizontalAlignment": "sample string 3", "anchorIgnoreIfNotPresent": "sample string 4", "anchorMatchWholeWord": "sample string 5", "anchorString": "sample string 6", "anchorTabProcessorVersion": "sample string 7", "anchorTabScope": "sample string 8", "anchorUnits": "sample string 9", "anchorXOffset": "sample string 10", "anchorYOffset": "sample string 11", "bold": "sample string 12", "caption": "sample string 13", "font": "sample string 14", "fontColor": "sample string 15", "fontSize": "sample string 16", "italic": "sample string 17", "locked": "sample string 18", "mergeFieldXml": "sample string 19", "pageNumber": "sample string 20", "required": "sample string 21", "selected": "sample string 22", "status": "sample string 23", "tabFullyQualifiedPath": "sample string 24", "tabId": "sample string 25", "tabOrder": "sample string 26", "underline": "sample string 27", "value": "sample string 28", "xPosition": "sample string 29", "yPosition": "sample string 30" } ], "recipientId": "sample string 6", "recipientIdGuid": "sample string 7", "requireAll": "sample string 8", "requireInitialOnSharedChange": "sample string 9", "shared": "sample string 10", "shareToRecipients": "sample string 11", "source": "sample string 12", "tabType": "sample string 13", "templateLocked": "sample string 14", "templateRequired": "sample string 15", "tooltip": "sample string 16", "value": "sample string 17" } ], "senderCompanyTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "senderNameTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "conditionalParentLabel": "sample string 16", "conditionalParentValue": "sample string 17", "customTabId": "sample string 18", "documentId": "sample string 19", "font": "sample string 20", "fontColor": "sample string 21", "fontSize": "sample string 22", "formOrder": "sample string 23", "formPageLabel": "sample string 24", "formPageNumber": "sample string 25", "height": "sample string 26", "italic": "sample string 27", "mergeFieldXml": "sample string 28", "name": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "source": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "underline": "sample string 43", "value": "sample string 44", "width": "sample string 45", "xPosition": "sample string 46", "yPosition": "sample string 47" } ], "ssnTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "requireAll": "sample string 38", "required": "sample string 39", "requireInitialOnSharedChange": "sample string 40", "senderRequired": "sample string 41", "shared": "sample string 42", "shareToRecipients": "sample string 43", "source": "sample string 44", "status": "sample string 45", "tabFullyQualifiedPath": "sample string 46", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 47", "tabLabel": "sample string 48", "tabOrder": "sample string 49", "tabType": "sample string 50", "templateLocked": "sample string 51", "templateRequired": "sample string 52", "tooltip": "sample string 53", "underline": "sample string 54", "validationMessage": "sample string 55", "validationPattern": "sample string 56", "value": "sample string 57", "width": "sample string 58", "xPosition": "sample string 59", "yPosition": "sample string 60" } ], "tabGroups": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "groupLabel": "sample string 22", "groupRule": "sample string 23", "height": "sample string 24", "maximumAllowed": "sample string 25", "mergeFieldXml": "sample string 26", "minimumRequired": "sample string 27", "pageNumber": "sample string 28", "recipientId": "sample string 29", "recipientIdGuid": "sample string 30", "source": "sample string 31", "status": "sample string 32", "tabFullyQualifiedPath": "sample string 33", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 34", "tabOrder": "sample string 35", "tabScope": "sample string 36", "tabType": "sample string 37", "templateLocked": "sample string 38", "templateRequired": "sample string 39", "tooltip": "sample string 40", "validationMessage": "sample string 41", "width": "sample string 42", "xPosition": "sample string 43", "yPosition": "sample string 44" } ], "textTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "formula": "sample string 28", "height": "sample string 29", "isPaymentAmount": "sample string 30", "italic": "sample string 31", "locked": "sample string 32", "maxLength": "sample string 33", "mergeFieldXml": "sample string 34", "name": "sample string 35", "originalValue": "sample string 36", "pageNumber": "sample string 37", "recipientId": "sample string 38", "recipientIdGuid": "sample string 39", "requireAll": "sample string 40", "required": "sample string 41", "requireInitialOnSharedChange": "sample string 42", "senderRequired": "sample string 43", "shared": "sample string 44", "shareToRecipients": "sample string 45", "source": "sample string 46", "status": "sample string 47", "tabFullyQualifiedPath": "sample string 48", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 49", "tabLabel": "sample string 50", "tabOrder": "sample string 51", "tabType": "sample string 52", "templateLocked": "sample string 53", "templateRequired": "sample string 54", "tooltip": "sample string 55", "underline": "sample string 56", "validationMessage": "sample string 57", "validationPattern": "sample string 58", "value": "sample string 59", "width": "sample string 60", "xPosition": "sample string 61", "yPosition": "sample string 62" } ], "zipTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "requireAll": "sample string 38", "required": "sample string 39", "requireInitialOnSharedChange": "sample string 40", "senderRequired": "sample string 41", "shared": "sample string 42", "shareToRecipients": "sample string 43", "source": "sample string 44", "status": "sample string 45", "tabFullyQualifiedPath": "sample string 46", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 47", "tabLabel": "sample string 48", "tabOrder": "sample string 49", "tabType": "sample string 50", "templateLocked": "sample string 51", "templateRequired": "sample string 52", "tooltip": "sample string 53", "underline": "sample string 54", "useDash4": "sample string 55", "validationMessage": "sample string 56", "validationPattern": "sample string 57", "value": "sample string 58", "width": "sample string 59", "xPosition": "sample string 60", "yPosition": "sample string 61" } ] }, "radioGroupTabs": [ {} ], "signerAttachmentTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "handDrawRequired": "sample string 22", "height": "sample string 23", "mergeFieldXml": "sample string 24", "name": "sample string 25", "optional": "sample string 26", "pageNumber": "sample string 27", "recipientId": "sample string 28", "recipientIdGuid": "sample string 29", "scaleValue": "sample string 30", "source": "sample string 31", "status": "sample string 32", "tabFullyQualifiedPath": "sample string 33", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 34", "tabLabel": "sample string 35", "tabOrder": "sample string 36", "tabType": "sample string 37", "templateLocked": "sample string 38", "templateRequired": "sample string 39", "tooltip": "sample string 40", "width": "sample string 41", "xPosition": "sample string 42", "yPosition": "sample string 43" } ], "signHereTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "documentId": "sample string 18", "formOrder": "sample string 19", "formPageLabel": "sample string 20", "formPageNumber": "sample string 21", "handDrawRequired": "sample string 22", "height": "sample string 23", "isSealSignTab": "sample string 24", "mergeFieldXml": "sample string 25", "name": "sample string 26", "optional": "sample string 27", "pageNumber": "sample string 28", "recipientId": "sample string 29", "recipientIdGuid": "sample string 30", "scaleValue": "sample string 31", "source": "sample string 32", "stamp": { "adoptedDateTime": "sample string 1", "createdDateTime": "sample string 2", "customField": "sample string 3", "dateStampProperties": { "dateAreaHeight": "sample string 1", "dateAreaWidth": "sample string 2", "dateAreaX": "sample string 3", "dateAreaY": "sample string 4" }, "disallowUserResizeStamp": "sample string 4", "externalID": "sample string 5", "imageBase64": "sample string 6", "imageType": "sample string 7", "lastModifiedDateTime": "sample string 8", "phoneticName": "sample string 9", "signatureName": "sample string 10", "stampFormat": "sample string 11", "stampImageUri": "sample string 12", "stampSizeMM": "sample string 13", "status": "sample string 14" }, "stampType": "sample string 33", "status": "sample string 34", "tabFullyQualifiedPath": "sample string 35", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 36", "tabLabel": "sample string 37", "tabOrder": "sample string 38", "tabType": "sample string 39", "templateLocked": "sample string 40", "templateRequired": "sample string 41", "tooltip": "sample string 42", "width": "sample string 43", "xPosition": "sample string 44", "yPosition": "sample string 45" } ], "smartSectionTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "caption": "sample string 14", "caseSensitive": true, "conditionalParentLabel": "sample string 15", "conditionalParentValue": "sample string 16", "customTabId": "sample string 17", "displaySettings": { "cellStyle": "sample string 1", "collapsibleSettings": { "arrowClosed": "sample string 1", "arrowColor": "sample string 2", "arrowLocation": "sample string 3", "arrowOpen": "sample string 4", "arrowSize": "sample string 5", "arrowStyle": "sample string 6", "containerStyle": "sample string 7", "labelStyle": "sample string 8", "onlyArrowIsClickable": true, "outerLabelAndArrowStyle": "sample string 9" }, "display": "sample string 2", "displayLabel": "sample string 3", "displayOrder": 4, "displayPageNumber": 5, "hideLabelWhenOpened": true, "inlineOuterStyle": "sample string 6", "labelWhenOpened": "sample string 7", "preLabel": "sample string 8", "scrollToTopWhenOpened": true, "tableStyle": "sample string 9" }, "documentId": "sample string 18", "endAnchor": "sample string 19", "endPosition": { "pageNumber": 1, "xPosition": 1.1, "yPosition": 1.1 }, "formOrder": "sample string 20", "formPageLabel": "sample string 21", "formPageNumber": "sample string 22", "height": "sample string 23", "locked": "sample string 24", "mergeFieldXml": "sample string 25", "overlayType": "sample string 26", "pageNumber": "sample string 27", "recipientId": "sample string 28", "recipientIdGuid": "sample string 29", "removeEndAnchor": true, "removeStartAnchor": true, "shared": "sample string 30", "source": "sample string 31", "startAnchor": "sample string 32", "status": "sample string 33", "tabFullyQualifiedPath": "sample string 34", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 35", "tabLabel": "sample string 36", "tabOrder": "sample string 37", "tabType": "sample string 38", "templateLocked": "sample string 39", "templateRequired": "sample string 40", "tooltip": "sample string 41", "width": "sample string 42", "xPosition": "sample string 43", "yPosition": "sample string 44" } ], "ssnTabs": [ {} ], "tabGroups": [ {} ], "textTabs": [ {} ], "titleTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "caption": "sample string 15", "concealValueOnDocument": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "disableAutoSize": "sample string 20", "documentId": "sample string 21", "font": "sample string 22", "fontColor": "sample string 23", "fontSize": "sample string 24", "formOrder": "sample string 25", "formPageLabel": "sample string 26", "formPageNumber": "sample string 27", "height": "sample string 28", "italic": "sample string 29", "locked": "sample string 30", "maxLength": "sample string 31", "mergeFieldXml": "sample string 32", "name": "sample string 33", "originalValue": "sample string 34", "pageNumber": "sample string 35", "recipientId": "sample string 36", "recipientIdGuid": "sample string 37", "required": "sample string 38", "source": "sample string 39", "status": "sample string 40", "tabFullyQualifiedPath": "sample string 41", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 42", "tabLabel": "sample string 43", "tabOrder": "sample string 44", "tabType": "sample string 45", "templateLocked": "sample string 46", "templateRequired": "sample string 47", "tooltip": "sample string 48", "underline": "sample string 49", "value": "sample string 50", "width": "sample string 51", "xPosition": "sample string 52", "yPosition": "sample string 53" } ], "viewTabs": [ { "agreementAttribute": "sample string 1", "agreementAttributeLocked": "sample string 2", "anchorAllowWhiteSpaceInCharacters": "sample string 3", "anchorCaseSensitive": "sample string 4", "anchorHorizontalAlignment": "sample string 5", "anchorIgnoreIfNotPresent": "sample string 6", "anchorMatchWholeWord": "sample string 7", "anchorString": "sample string 8", "anchorTabProcessorVersion": "sample string 9", "anchorTabScope": "sample string 10", "anchorUnits": "sample string 11", "anchorXOffset": "sample string 12", "anchorYOffset": "sample string 13", "bold": "sample string 14", "buttonText": "sample string 15", "caption": "sample string 16", "conditionalParentLabel": "sample string 17", "conditionalParentValue": "sample string 18", "customTabId": "sample string 19", "documentId": "sample string 20", "font": "sample string 21", "fontColor": "sample string 22", "fontSize": "sample string 23", "formOrder": "sample string 24", "formPageLabel": "sample string 25", "formPageNumber": "sample string 26", "height": "sample string 27", "italic": "sample string 28", "mergeFieldXml": "sample string 29", "pageNumber": "sample string 30", "recipientId": "sample string 31", "recipientIdGuid": "sample string 32", "required": "sample string 33", "requiredRead": "sample string 34", "source": "sample string 35", "status": "sample string 36", "tabFullyQualifiedPath": "sample string 37", "tabGroupLabels": [ "sample string 1" ], "tabId": "sample string 38", "tabLabel": "sample string 39", "tabOrder": "sample string 40", "tabType": "sample string 41", "templateLocked": "sample string 42", "templateRequired": "sample string 43", "tooltip": "sample string 44", "underline": "sample string 45", "width": "sample string 46", "xPosition": "sample string 47", "yPosition": "sample string 48" } ], "zipTabs": [ {} ] } ```