DocuSign: Esignature schemas (part 23)
32 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings document Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
showEditDocumentVisibility | string | Optional | When `false`, prevents the user from modifying document visibility settings. The default value is `true`. |
showEditDocuments | string | Optional | When **false,** prevents the app user from adding, replacing, or deleting documents. The default value is **true.** |
showEditPages | string | Optional | When `false`, prevents the user from deleting or rotating individual document pages via the thumbnail images. The default value is `true`. If `true` and `showEditDocuments` is `false`, the pages can be rotated but not deleted. |
showSaveAsDocumentCustomField | string | Optional | Reserved for Docusign. |
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings envelope Custom Field Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
showEnvelopeCustomFields | string | Optional | Reserved for Docusign. |
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings recipient Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
showBulkSend | string | Optional | Reserved for Docusign. |
showContactsList | string | Optional | Reserved for Docusign. |
showEditMessage | string | Optional | Reserved for Docusign. |
showEditRecipients | string | Optional | When `false`, prevents the user from changing the recipients from the **Tagger** page. The default value is `true`. |
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paletteDefault | string | Optional | When `paletteSections` is set to `custom`, this property selects the default tagger palette. Valid values: * `custom` * `merge` * `notary` * `seals` * `smartContracts` * `annotations` * `smartSections` |
paletteSections | string | Optional | Valid values: * `default` (default): The default tagger palette UX * `none`: No tagger palette * `custom`: Set by `paletteDefault` |
paletteSettings | Model | Optional | Expand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings palette Settings Reserved for Docusign. |
Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings palette Settings
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings palette Settings
Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings palette Settings merge
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings palette Settings merge
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
show | string | Optional | Reserved for Docusign. |
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings template Settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
showMatchingTemplatesPrompt | string | Optional | Reserved for Docusign. |
Returns a URL to the edit view UI Use before an envelope has been sent — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Provides a URL that you can embed in your application to provide access to the Docusign UI. ### Related topics - [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/) - [Send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/) - [Introducing customizable embedded sending](https://www.docusign.com/blog/developers/introducing-customizable-embedded-sending) |
url | string | Optional | The view URL to be navigated to. |
Returns a URL to the shared recipient view UI for an envelope — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) and [EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods. |
assertionId | string | Optional | A unique identifier of the authentication event executed by the client application. |
authenticationInstant | string | Optional | A sender-generated value that indicates the date and time that the signer was authenticated. |
authenticationMethod | string | Optional | Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. Choose a value from this list: * Biometric * HTTPBasicAuth * Kerberos * KnowledgeBasedAuth * None * PaperDocuments * Password * RSASecureID * SingleSignOn_CASiteminder * SingleSignOn_InfoCard * SingleSignOn_MicrosoftActiveDirectory * SingleSignOn_Other * SingleSignOn_Passport * SingleSignOn_SAML * Smartcard * SSLMutualAuth * X509Certificate This information is included in the Certificate of Completion. |
clientURLs | Model | Optional | Expand Creates a template recipient preview — request body — body client UR Ls |
clientUserId | string | Optional | A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer. Use your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated. Maximum length: 100 characters. |
displayFormat | string | Optional | |
email | string | Optional | (Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient. |
frameAncestors | array | Optional | An array of ancestors that can embed the frame. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/). In the demo environment, include your site URL and `https://apps-d.docusign.com`. You can use `http://localhost` for local development and testing. Example: `["https://my.site.com", "https://apps-d.docusign.com"]` In the production environment, include your site URL and `https://apps.docusign.com`. HTTPS must be enabled on your site. Example: `["https://my.site.com", "https://apps.docusign.com"]` |
frameAncestors[] | string | Each item | |
messageOrigins | array | Optional | The originating domain for the signature request message. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/). In the demo environment, the value must be `https://apps-d.docusign.com`. In production, the value must be `https://apps.docusign.com`. |
messageOrigins[] | string | Each item | |
pingFrequency | string | Optional | Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds. |
pingUrl | string | Optional | The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received. |
recipientId | string | Optional | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |
returnUrl | string | Optional | (Required) The URL to which the user should be redirected after the signing session has ended. Maximum Length: 470 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL Be sure to include `https://` in the URL or redirecting might fail on some browsers. When Docusign redirects to this URL, it will include an `event` query parameter that your app can use: * `access_code_failed`: Recipient used incorrect access code. * `cancel`: Recipient canceled the signing operation, possibly by using the **Finish Later** option. * `decline`: Recipient declined to sign. * `exception`: A system error occurred during the signing process. * `fax_pending`: Recipient has a fax pending. * `id_check_failed`: Recipient failed an ID check. * `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option. * `signing_complete`: The recipient completed the signing ceremony. * `ttl_expired`: The Time To Live token for the envelope has expired. After being successfully invoked, these tokens expire after five minutes. * `viewing_complete`: The recipient completed viewing an envelope that is in a read-only/terminal state, such as completed, declined, or voided. |
securityDomain | string | Optional | The domain in which the user authenticated. |
userId | string | Optional | The user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. If `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. If a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user. |
userName | string | Optional | The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient. |
xFrameOptions | string | Optional | Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. Valid values are: - `deny`: The page cannot be displayed in a frame. - `same_origin`: The page can only be displayed in a frame on the same origin as the page itself. - `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property. |
xFrameOptionsAllowFromUrl | string | Optional | When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property. |
Referenced models: Creates a template recipient preview — request body — body client UR Ls
Returns a list of Power Forms — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of PowerForms. |
endPosition | JSON | Optional | |
endPosition (anyOf 1) | integer | Alternative | The last index position in the result set. Format: int32 |
endPosition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
powerForms | array | Optional | An array of PowerForm objects. |
powerForms[] | Model | Each item | Expand Creates a new Power Form — response body |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | JSON | Optional | |
resultSetSize (anyOf 1) | integer | Alternative | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. Format: int32 |
resultSetSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startPosition | JSON | Optional | |
startPosition (anyOf 1) | integer | Alternative | The starting index position of the current result set. Format: int32 |
startPosition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalSetSize | JSON | Optional | |
totalSetSize (anyOf 1) | integer | Alternative | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. Format: int32 |
totalSetSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Creates a new Power Form — response body
Returns a list of bulk send batch summaries — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of bulk send batch summaries. |
batchSizeLimit | string | Optional | The maximum number of envelopes the account is permitted to submit in a given batch. |
bulkBatchSummaries | array | Optional | An array of batch summaries. |
bulkBatchSummaries[] | Model | Each item | Expand Returns a list of bulk send batch summaries — response body — bulk Batch Summaries item |
bulkProcessQueueLimit | string | Optional | |
bulkProcessTotalQueued | string | Optional | |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
queueLimit | string | Optional | Maximum number of envelopes an account is permitted to have in the queue at any one time. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalQueued | string | Optional | The number of envelopes currently pending processing for the entire account. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Returns a list of bulk send batch summaries — response body — bulk Batch Summaries item
Returns a list of bulk send batch summaries — response body — bulk Batch Summaries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Summary status of a single batch. |
action | string | Optional | |
actionStatus | string | Optional | |
batchId | string | Optional | The batch ID. |
batchName | string | Optional | The name of the batch. |
batchSize | string | Optional | The number of envelopes in the batch. |
batchUri | string | Optional | The batch details URI. |
failed | string | Optional | Number of envelopes that failed to send. |
queued | string | Optional | Number of envelopes peding processing. |
sent | string | Optional | Number of envelopes that have been sent. |
submittedDate | string | Optional | The time stamp of when the batch was created in ISO 8601 format. |
Returns a list of jurisdictions that the notary is registered in — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A paged list of jurisdictions. |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
notaryJurisdictions | array | Optional | An array of jurisdictions. |
notaryJurisdictions[] | Model | Each item | Expand Creates a jurisdiction object — response body |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Creates a jurisdiction object — response body
Returns a list of stamps available in the account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountSignatures | array | Optional | |
accountSignatures[] | Model | Each item | Expand Deletes the image for a stamp — response body |
Referenced models: Deletes the image for a stamp — response body
Returns a list of the account's folders — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
envelopes | array | Optional | |
envelopes[] | Model | Each item | Expand Creates an envelope — response body |
folders | array | Optional | A list of folder objects. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Creates an envelope — response body, Gets the list of templates — response body — folders item
Returns a permission profile for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object defines the account permissions for a profile that you can apply to a group of users. |
modifiedByUsername | string | Optional | The username of the user who last modified the permission profile. |
modifiedDateTime | string | Optional | The date and time when the permission profile was last modified. |
permissionProfileId | string | Optional | The ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the **Settings > Permission Profiles** page of your eSignature account page. |
permissionProfileName | string | Optional | The name of the account permission profile. Example: `Account Administrator` |
settings | Model | Optional | Expand Returns a permission profile for an account — response body — settings This object specifies the permissions that are associated with the account permission profile. |
userCount | string | Optional | The total number of users in the group associated with the account permission profile. |
users | array | Optional | A list of user objects containing information about the users who are associated with the account permission profile. |
users[] | Model | Each item | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body |
Referenced models: Returns a permission profile for an account — response body — settings, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Returns a permission profile for an account — response body — settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object defines account permissions for users who are associated with the account permission profile. |
accountAgreementsAccessType | string | Optional | |
accountAgreementsAccessTypeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
accountManagementGranular | Model | Optional | Expand Returns a permission profile for an account — response body — settings account Management Granular Describes which account management capabilities a user has. |
allowAccountManagement | string | Optional | When **true,** users have full administrative access to the account. |
allowAccountManagementMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowAccountManagement` property is editable. |
allowApiAccess | string | Optional | When **true,** users can manage documents by using the API. |
allowApiAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowApiAccess` property is editable. |
allowApiAccessToAccount | string | Optional | When **true,** users can access the account by using the eSignature API. |
allowApiAccessToAccountMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowApiAccessToAccount` property is editable. |
allowApiSendingOnBehalfOfOthers | string | Optional | When **true,** users can send envelopes on behalf of others. |
allowApiSendingOnBehalfOfOthersMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowApiSendingOnBehalfOfOthers` property is editable. |
allowApiSequentialSigning | string | Optional | When **true,** users may specify sequential signing recipients when they send documents by using the API. |
allowApiSequentialSigningMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowApiSequentialSigning` property is editable. |
allowAutoTagging | string | Optional | When **true,** auto-tagging is enabled for the account. |
allowAutoTaggingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowAutoTagging` property is editable. |
allowBulkSending | string | Optional | When **true,** bulk sending is enabled for users. |
allowBulkSendingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowBulkSending` property is editable. |
allowDocuSignDesktopClient | string | Optional | When **true,** the Docusign Desktop Client is enabled for users. |
allowDocuSignDesktopClientMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowDocuSignDesktopClient` property is editable. |
allowESealRecipients | string | Optional | When **true,** users can add electronic seal ([eSeal](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html)) recipients. |
allowESealRecipientsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowESealRecipients` property is editable. |
allowEnvelopeSending | string | Optional | When **true,** users can send envelopes. |
allowEnvelopeSendingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowEnvelopeSending` property is editable. |
allowPowerFormsAdminToAccessAllPowerFormEnvelopes | string | Optional | When **true,** PowerForm Administrators can access all of the PowerForm envelopes associated with the account. |
allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowPowerFormsAdminToAccessAllPowerFormEnvelopes` property is editable. |
allowSendersToSetRecipientEmailLanguage | string | Optional | When **true,** senders can set the language of the email that is sent to recipients. |
allowSendersToSetRecipientEmailLanguageMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowSendersToSetRecipientEmailLanguage` property is editable. |
allowSignerAttachments | string | Optional | When **true,** users can add requests for attachments from signers. |
allowSignerAttachmentsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowSignerAttachments` property is editable. |
allowSupplementalDocuments | string | Optional | When **true,** senders can include supplemental documents. |
allowSupplementalDocumentsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowSupplementalDocuments` property is editable. |
allowTaggingInSendAndCorrect | string | Optional | When **true,** the tagger palette is visible during the sending and correct flows and users can add tabs to documents. |
allowTaggingInSendAndCorrectMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowTaggingInSendAndCorrect` property is editable. |
allowTransactions | string | Optional | |
allowTransactionsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
allowVaulting | string | Optional | Reserved for Docusign. |
allowVaultingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
allowWetSigningOverride | string | Optional | When **true,** users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis. |
allowWetSigningOverrideMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowWetSigningOverride` property is editable. |
allowedAddressBookAccess | string | Optional | Specifies the level of access that users have to the account's address book. Valid values are: - `personal` - `useShared` - `usePersonalAndShared` - `personalAndShared` |
allowedAddressBookAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowedAddressBookAccess` property is editable. |
allowedClickwrapsAccess | string | Optional | |
allowedClickwrapsAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
allowedDocumentTemplateLibraryAccess | string | Optional | |
allowedDocumentTemplateLibraryAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
allowedOrchestrationAccess | string | Optional | |
allowedOrchestrationAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
allowedTemplateAccess | string | Optional | Specifies the level of access that users have to account templates. Valid values are: - `none` - `use` - `create` - `share` |
allowedTemplateAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowedTemplateAccess` property is editable. |
allowedToBeEnvelopeTransferRecipient | string | Optional | When **true,** users can be recipients of envelopes transferred to them by administrators of other accounts. |
allowedToBeEnvelopeTransferRecipientMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowedToBeEnvelopeTransferRecipient` property is editable. |
canBulkUploadAgreements | string | Optional | |
canBulkUploadAgreementsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canCreateTransaction | string | Optional | |
canCreateTransactionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canCreateWorkspaces | string | Optional | Reserved for Docusign. |
canCreateWorkspacesMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
canDeleteDocumentsInTransaction | string | Optional | |
canDeleteDocumentsInTransactionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canDeleteTransaction | string | Optional | |
canDeleteTransactionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageAgreementDeskRequest | string | Optional | |
canManageAgreementDeskRequestMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageAgreementDeskRequestSetting | string | Optional | |
canManageAgreementDeskRequestSettingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canSendEnvelopesViaSMS | string | Optional | |
canSendEnvelopesViaSMSMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
disableDocumentUpload | string | Optional | When **true,** users cannot upload documents. |
disableDocumentUploadMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `disableDocumentUpload` property is editable. |
disableOtherActions | string | Optional | When **true,** users can access the **Other Actions** menu. |
disableOtherActionsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `disableOtherActions` property is editable. |
enableApiRequestLogging | string | Optional | When **true,** API request logging is enabled. **Note:** Logging limits apply. |
enableApiRequestLoggingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableApiRequestLogging` property is editable. |
enableKeyTermsSuggestionsByDocumentType | string | Optional | |
enableKeyTermsSuggestionsByDocumentTypeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
enableRecipientViewingNotifications | string | Optional | When **true,** senders are notified when recipients view the documents that they send. |
enableRecipientViewingNotificationsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableRecipientViewingNotifications` property is editable. |
enableSequentialSigningInterface | string | Optional | When **true,** the sequential signing user interface is enabled. |
enableSequentialSigningInterfaceMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableSequentialSigningInterface` property is editable. |
enableTransactionPointIntegration | string | Optional | Reserved for Docusign. |
enableTransactionPointIntegrationMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
playbookAccess | string | Optional | |
playbookAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
powerFormRole | string | Optional | The PowerForms rights associated with the account permission profile. Valid values are: - `none` - `user` - `admin` |
powerFormRoleMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `powerFormRole` property is editable. |
receiveCompletedSelfSignedDocumentsAsEmailLinks | string | Optional | When **true,** senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments. |
receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `receiveCompletedSelfSignedDocumentsAsEmailLinks` property is editable. |
signingUiVersionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
supplementalDocumentsMustAccept | string | Optional | When **true,** senders can require recipients to accept supplemental documents. |
supplementalDocumentsMustAcceptMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable. |
supplementalDocumentsMustRead | string | Optional | When **true,** senders can require recipients to read supplemental documents. |
supplementalDocumentsMustReadMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable. |
supplementalDocumentsMustView | string | Optional | When **true,** users can require recipients to view supplemental documents. |
supplementalDocumentsMustViewMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `supplementalDocumentsMustView` property is editable. |
useNewDocuSignExperienceInterface | string | Optional | Reserved for Docusign. |
useNewDocuSignExperienceInterfaceMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
useNewSendingInterface | string | Optional | Reserved for Docusign. |
useNewSendingInterfaceMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
vaultingMode | string | Optional | Reserved for Docusign. |
vaultingModeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
webForms | string | Optional | |
webFormsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
Referenced models: Returns a permission profile for an account — response body — settings account Management Granular, Gets the user account settings for a specified user — response body — locale Metadata
Returns a permission profile for an account — response body — settings account Management Granular
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Returns all users from the configured Connect service — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
users | array | Optional | User management information. |
users[] | Model | Each item | Expand Returns all users from the configured Connect service — response body — users item |
Referenced models: Returns all users from the configured Connect service — response body — users item
Returns all users from the configured Connect service — response body — users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | |
isIncluded | string | Optional | |
userId | string | Optional | The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. |
userName | string | Optional | The name of the user. |
Returns available seals for specified account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
seals | array | Optional | A list of electronic seals to apply to documents. |
seals[] | Model | Each item | Expand Returns available seals for specified account — response body — seals item |
Referenced models: Returns available seals for specified account — response body — seals item
Returns available seals for specified account — response body — seals item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
sealDisplayName | string | Optional | The user-friendly display name for a seal. |
sealName | string | Optional | The name of a seal. |
Returns downgrade plan information for the specified account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
downgradePlanInformation | Model | Optional | Expand Queues downgrade billing plan request for an account — response body |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
Referenced models: Queues downgrade billing plan request for an account — response body
Returns envelope tab data for an existing envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes the form data of the envelope. |
emailSubject | string | Optional | The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
formData | array | Optional | An array of `formDataItem` objects. |
formData[] | Model | Each item | Expand Returns envelope tab data for an existing envelope — response body — form Data item |
prefillFormData | Model | Optional | Expand Returns envelope tab data for an existing envelope — response body — prefill Form Data An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs). |
recipientFormData | array | Optional | An array of form data for each recipient of the envelope. |
recipientFormData[] | Model | Each item | Expand Returns envelope tab data for an existing envelope — response body — recipient Form Data item |
sentDateTime | string | Optional | The UTC DateTime when the envelope was sent. This property is read-only. |
status | string | Optional | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. |
Referenced models: Returns envelope tab data for an existing envelope — response body — form Data item, Returns envelope tab data for an existing envelope — response body — prefill Form Data, Returns envelope tab data for an existing envelope — response body — recipient Form Data item
Returns envelope tab data for an existing envelope — response body — form Data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
listSelectedValue | string | Optional | The selected value in a list. |
name | string | Optional | The name of the form field. |
numericalValue | string | Optional | |
originalNumericalValue | string | Optional | |
originalValue | string | Optional | The initial value associated with the form field. |
value | string | Optional | The current value associated with the form field. |
Referenced models: Locks a template — response body — error Details
Returns envelope tab data for an existing envelope — response body — prefill Form Data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
formData | array | Optional | |
formData[] | Model | Each item | Expand Returns envelope tab data for an existing envelope — response body — form Data item |
senderEmail | string | Optional | The sender's email address. |
senderName | string | Optional | The sender's name. |
senderUserId | string | Optional | The ID of the sender. |
Referenced models: Returns envelope tab data for an existing envelope — response body — form Data item
Returns envelope tab data for an existing envelope — response body — recipient Form Data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
DeclinedTime | string | Optional | The date and time the recipient declined the envelope. |
DeliveredTime | string | Optional | The date and time the recipient viewed the documents in the envelope in the Docusign signing UI. |
SentTime | string | Optional | The date and time the envelope was sent to the recipient. |
SignedTime | string | Optional | The date and time the recipient signed the documents. |
email | string | Optional | The recipient's email address. |
formData | array | Optional | An array of form data objects. |
formData[] | Model | Each item | Expand Returns envelope tab data for an existing envelope — response body — form Data item |
name | string | Optional | The name of the recipient. |
recipientId | string | Optional | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |
Referenced models: Returns envelope tab data for an existing envelope — response body — form Data item
Returns metadata about the branding resources for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
resourcesContentTypes | array | Optional | A list of resources that the brand uses. |
resourcesContentTypes[] | Model | Each item | Expand Updates a branding resource file — response body |
Referenced models: Updates a branding resource file — response body
Returns sender fields for an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object for document generation responses. |
docGenFormFields | array | Optional | A list of `docGenFormFields` objects. |
docGenFormFields[] | Model | Each item | Expand Returns sender fields for an envelope — response body — doc Gen Form Fields item |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
Referenced models: Returns sender fields for an envelope — response body — doc Gen Form Fields item, Locks a template — response body — error Details
Returns sender fields for an envelope — response body — doc Gen Form Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A collection of document generation fields. |
docGenDocumentStatus | string | Optional | The status of the document. This is a read-only property, and not used in [updateEnvelopeDocGenFormFields][docgen update]. Valid values: - `mergesucceeded` - `created` - `hassyntaxerror` [docgen update]: /docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/ |
docGenErrors | array | Optional | A list of `docGenSyntaxError` objects. |
docGenErrors[] | Model | Each item | Expand Updates a template document — response body — doc Gen Errors item |
docGenFormFieldList | array | Optional | A list of `docGenFormField` objects. |
docGenFormFieldList[] | Model | Each item | Expand Updates a template document — response body — doc Gen Form Fields item |
documentId | string | Optional | The GUID of the document. |
Referenced models: Updates a template document — response body — doc Gen Form Fields item, Updates a template document — response body — doc Gen Errors item
Returns tabs on a template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approveTabs | array | Optional | A list of [Approve tabs][approve]. 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. [approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
approveTabs[] | Model | Each item | Expand Returns tabs on a template — response body — approve Tabs item |
checkboxTabs | array | Optional | A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
checkboxTabs[] | Model | Each item | Expand Returns tabs on a template — response body — checkbox Tabs item |
commentThreadTabs | array | 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. |
commentThreadTabs[] | Model | Each item | Expand Returns tabs on a template — response body — comment Thread Tabs item |
commissionCountyTabs | array | Optional | A list of [Commission County tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionCountyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission County Tabs item |
commissionExpirationTabs | array | Optional | A list of [Commission Expiration tabs][tabref]. 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][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionExpirationTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Expiration Tabs item |
commissionNumberTabs | array | Optional | A list of [Commission Number tabs][tabref]. A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Number Tabs item |
commissionStateTabs | array | Optional | A list of [Commission State tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionStateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission State Tabs item |
companyTabs | array | Optional | A list of [Company tabs][company]. A Company tab displays a field for the name of the recipient's company. This value can't be set. [company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company |
companyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — company Tabs item |
dateSignedTabs | array | Optional | A list of [Date Signed tabs][dateSigned]. A Date Signed tab displays the date that the recipient signed the document. This value can't be set. [dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateSignedTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Signed Tabs item |
dateTabs | array | Optional | A list of [Date tabs][date]. 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. [date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Tabs item |
declineTabs | array | Optional | A list of [Decline tabs][decline]. 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. [decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
declineTabs[] | Model | Each item | Expand Returns tabs on a template — response body — decline Tabs item |
drawTabs | array | Optional | A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. |
drawTabs[] | Model | Each item | Expand Returns tabs on a template — response body — draw Tabs item |
emailAddressTabs | array | Optional | A list of [Email Address tabs][emailAddress]. An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. [emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailAddressTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Address Tabs item |
emailTabs | array | Optional | A list of [Email tabs][email]. 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. [email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Tabs item |
envelopeIdTabs | array | Optional | A list of [Envelope ID tabs][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. [envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid |
envelopeIdTabs[] | Model | Each item | Expand Returns tabs on a template — response body — envelope Id Tabs item |
firstNameTabs | array | Optional | A list of [First Name tabs][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. [firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname |
firstNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — first Name Tabs item |
formulaTabs | array | Optional | A list of [Formula tabs][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. 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][calculatedfields]. 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][paymentguide]. [calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html [paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html [formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
formulaTabs[] | Model | Each item | Expand Returns tabs on a template — response body — formula Tabs item |
fullNameTabs | array | Optional | A list of [Full Name tabs][fullName]. A Full Name tab displays the recipient's full name. This value can't be set. [fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
fullNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — full Name Tabs item |
initialHereTabs | array | Optional | A list of [Initial Here tabs][initialHere]. This type of tab enables the recipient to initial the document. May be optional. This value can't be set. [initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
initialHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — initial Here Tabs item |
lastNameTabs | array | Optional | A list of [Last Name tabs][lastName]. 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. [lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
lastNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — last Name Tabs item |
listTabs | array | 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][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
listTabs[] | Model | Each item | Expand Returns tabs on a template — response body — list Tabs item |
notarizeTabs | array | Optional | A list of [Notarize tabs][notarize]. 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. [notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
notarizeTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notarize Tabs item |
notarySealTabs | array | 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][notary]. [notary]: /docs/notary-api/ |
notarySealTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notary Seal Tabs item |
noteTabs | array | Optional | A list of [Note tabs][note]. A Note tab displays additional information to the recipient in the form of a note. This value can be set. [note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
noteTabs[] | Model | Each item | Expand Returns tabs on a template — response body — note Tabs item |
numberTabs | array | 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). [number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
numberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — number Tabs item |
numericalTabs | array | 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). |
numericalTabs[] | Model | Each item | Expand Returns tabs on a template — response body — numerical Tabs item |
phoneNumberTabs | array | Optional | A list of [Phone Number tabs][cc]. 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]. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
phoneNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — phone Number Tabs item |
polyLineOverlayTabs | array | Optional | This type of tab enables the recipient to strike through document text. This value can't be set. |
polyLineOverlayTabs[] | Model | Each item | Expand Returns tabs on a template — response body — poly Line Overlay Tabs item |
prefillTabs | Model | Optional | Expand Returns tabs on a template — response body — prefill Tabs 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. [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/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
radioGroupTabs | array | Optional | A list of [Radio Group tabs][radioGroup]. 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. [radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
radioGroupTabs[] | Model | Each item | Expand Returns tabs on a template — response body — radio Group Tabs item |
signHereTabs | array | Optional | A list of [Sign Here tabs][signHere]. This type of tab enables the recipient to sign a document. May be optional. This value can't be set. [signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — sign Here Tabs item |
signerAttachmentTabs | array | Optional | A list of [Signer Attachment tabs][signerAttachment]. This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. [signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signerAttachmentTabs[] | Model | Each item | Expand Returns tabs on a template — response body — signer Attachment Tabs item |
smartSectionTabs | array | 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. |
smartSectionTabs[] | Model | Each item | Expand Returns tabs on a template — response body — smart Section Tabs item |
ssnTabs | array | Optional | A list of [SSN tabs][ssn]. 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. [ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
ssnTabs[] | Model | Each item | Expand Returns tabs on a template — response body — ssn Tabs item |
tabGroups | array | 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. |
tabGroups[] | Model | Each item | Expand Returns tabs on a template — response body — tab Groups item |
textTabs | array | 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][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
textTabs[] | Model | Each item | Expand Returns tabs on a template — response body — text Tabs item |
titleTabs | array | Optional | A list of [Title tabs][title]. A Title tab displays the recipient's title. This value can't be set. [title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
titleTabs[] | Model | Each item | Expand Returns tabs on a template — response body — title Tabs item |
viewTabs | array | Optional | A list of [View tabs][view]. A View tab is used with an Approve tab to handle supplemental documents. This value can be set. [view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
viewTabs[] | Model | Each item | Expand Returns tabs on a template — response body — view Tabs item |
zipTabs | array | Optional | A list of [Zip tabs][zip]. 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. [zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
zipTabs[] | Model | Each item | Expand Returns tabs on a template — response body — zip Tabs item |
Referenced models: Returns tabs on a template — response body — approve Tabs item, Returns tabs on a template — response body — checkbox Tabs item, Returns tabs on a template — response body — comment Thread Tabs item, Returns tabs on a template — response body — commission County Tabs item, Returns tabs on a template — response body — commission Expiration Tabs item, Returns tabs on a template — response body — commission Number Tabs item, Returns tabs on a template — response body — commission State Tabs item, Returns tabs on a template — response body — company Tabs item, Returns tabs on a template — response body — date Tabs item, Returns tabs on a template — response body — date Signed Tabs item, Returns tabs on a template — response body — decline Tabs item, Returns tabs on a template — response body — draw Tabs item, Returns tabs on a template — response body — email Tabs item, Returns tabs on a template — response body — email Address Tabs item, Returns tabs on a template — response body — envelope Id Tabs item, Returns tabs on a template — response body — first Name Tabs item, Returns tabs on a template — response body — formula Tabs item, Returns tabs on a template — response body — full Name Tabs item, Returns tabs on a template — response body — initial Here Tabs item, Returns tabs on a template — response body — last Name Tabs item, Returns tabs on a template — response body — list Tabs item, Returns tabs on a template — response body — notarize Tabs item, Returns tabs on a template — response body — notary Seal Tabs item, Returns tabs on a template — response body — note Tabs item, Returns tabs on a template — response body — number Tabs item, Returns tabs on a template — response body — numerical Tabs item, Returns tabs on a template — response body — phone Number Tabs item, Returns tabs on a template — response body — poly Line Overlay Tabs item, Returns tabs on a template — response body — prefill Tabs, Returns tabs on a template — response body — radio Group Tabs item, Returns tabs on a template — response body — sign Here Tabs item, Returns tabs on a template — response body — signer Attachment Tabs item, Returns tabs on a template — response body — smart Section Tabs item, Returns tabs on a template — response body — ssn Tabs item, Returns tabs on a template — response body — tab Groups item, Returns tabs on a template — response body — text Tabs item, Returns tabs on a template — response body — title Tabs item, Returns tabs on a template — response body — view Tabs item, Returns tabs on a template — response body — zip Tabs item
Returns tabs on a template — response body — approve Tabs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tab that allows the recipient to approve documents without placing a signature or initials on the document. |
agreementAttribute | string | Optional | |
agreementAttributeLocked | string | Optional | |
anchorAllowWhiteSpaceInCharacters | string | Optional | When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match. The default value is **true.** |
anchorAllowWhiteSpaceInCharactersMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. |
anchorCaseSensitive | string | Optional | This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorCaseSensitiveMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorCaseSensitive` property is editable. |
anchorHorizontalAlignment | string | Optional | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorHorizontalAlignmentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. |
anchorIgnoreIfNotPresent | string | Optional | When **true,** this tab is ignored if the `anchorString` is not found in the document. |
anchorIgnoreIfNotPresentMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. |
anchorMatchWholeWord | string | Optional | When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ |
anchorMatchWholeWordMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorMatchWholeWord` property is editable. |
anchorString | string | Optional | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorString` property is editable. |
anchorTabProcessorVersion | string | Optional | Reserved for Docusign. |
anchorTabProcessorVersionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
anchorTabScope | string | Optional | |
anchorUnits | string | Optional | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` |
anchorUnitsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorUnits` property is editable. |
anchorXOffset | string | Optional | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorXOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorXOffset` property is editable. |
anchorYOffset | string | Optional | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. |
anchorYOffsetMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `anchorYOffset` property is editable. |
bold | string | Optional | When **true,** the information in the tab is bold. |
boldMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `bold` property is editable. |
buttonText | string | Optional | Specifies the approval text that displays in the tab. |
buttonTextMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `buttonText` property is editable. |
caption | string | Optional | |
captionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `caption` property is editable. |
conditionalParentLabel | string | Optional | For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. |
conditionalParentLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentLabel` property is editable. |
conditionalParentValue | string | Optional | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. |
conditionalParentValueMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `conditionalParentValue` property is editable. |
connectedObjectDetails | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item connected Object Details |
customTabId | string | Optional | The Docusign-generated custom tab ID for the custom tab to be applied. 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 | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `customTabId` property is editable. |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `documentId` property is editable. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
extensionData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data |
font | string | Optional | The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana |
fontColor | string | Optional | The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White |
fontColorMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fontColor` property is editable. |
fontMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `font` property is editable. |
fontSize | string | Optional | The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 |
fontSizeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fontSize` property is editable. |
formOrder | string | Optional | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. |
formOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formOrder` property is editable. |
formPageLabel | string | Optional | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `formPageLabel` property is editable. |
formPageNumber | string | Optional | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `fromPageNumber` property is editable. |
height | string | Optional | The height of the tab in pixels. Must be an integer. |
heightMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `height` property is editable. |
italic | string | Optional | When **true,** the information in the tab is italic. |
italicMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `italic` property is editable. |
localePolicy | Model | Optional | Expand Creates a custom tab — response body — locale Policy Locale-specific settings. |
mergeField | Model | Optional | Expand Creates a custom tab — response body — merge Field Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | Optional | Reserved for Docusign. |
pageNumber | string | Optional | Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`. |
pageNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `pageNumber` property is editable. |
recipientId | string | Optional | The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientIdGuidMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientIdGuid` property is editable. |
recipientIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientId` property is editable. |
smartContractInformation | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item smart Contract Information Reserved for Docusign. |
source | string | Optional | Reserved for Docusign. |
status | string | Optional | The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). |
statusMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `status` property is editable. |
tabFullyQualifiedPath | string | Optional | |
tabGroupLabels | array | Optional | An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. |
tabGroupLabels[] | string | Each item | |
tabGroupLabelsMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabGroupLabels` property is editable. |
tabId | string | Optional | The unique identifier for the tab. |
tabIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabId` property is editable. |
tabLabel | string | Optional | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabLabel` property is editable. |
tabOrder | string | Optional | A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. |
tabOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabOrder` property is editable. |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
tabTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `tabType` property is editable. |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateLocked` property is editable. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `templateRequired` property is editable. |
toolTipMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `toolTip` property is editable. |
tooltip | string | Optional | **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. |
underline | string | Optional | When **true,** the information in the tab is underlined. |
underlineMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `underline` property is editable. |
warningDetails | Model | Optional | Expand Locks a template — response body — error Details |
width | string | Optional | The width of the tab in pixels. Must be an integer. |
widthMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `width` property is editable. |
xPosition | string | Optional | This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) |
xPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `xPosition` property is editable. |
yPosition | string | Optional | This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) |
yPositionMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `yPosition` property is editable. |
Referenced models: Returns tabs on a template — response body — ssn Tabs item connected Object Details, Locks a template — response body — error Details, Returns tabs on a template — response body — ssn Tabs item extension Data, Creates a custom tab — response body — locale Policy, Creates a custom tab — response body — merge Field, Updates a template document — response body — name Metadata, Returns tabs on a template — response body — ssn Tabs item smart Contract Information