Skip to navigation

Update tab settings

View as Markdown
This method modifies the tab types and tab functionality that is enabled for an account.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Request

This endpoint expects an object: tabAccountSettings

allowTabOrderstringOptional

When true, account users can set a tab order for the signing process.

Note: Only Admin users can change this setting.

allowTabOrderMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

approveDeclineTabsEnabledstringOptional

When true, approve and decline tabs are enabled.

approveDeclineTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

calculatedFieldsEnabledstringOptional

When true, calculated fields are enabled for tabs.

calculatedFieldsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

checkboxTabsEnabledstringOptional

When true, checkbox tabs are enabled.

checkBoxTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

dataFieldRegexEnabledstringOptional

When true, regular expressions are enabled for tabs that contain data fields.

dataFieldRegexMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

dataFieldSizeEnabledstringOptional

When true, setting character limits for input fields is enabled.

dataFieldSizeMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

drawTabsEnabledstringOptional
drawTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

enableTabAgreementDetailsstringOptional
enableTabAgreementDetailsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

firstLastEmailTabsEnabledstringOptional
Reserved for Docusign.
firstLastEmailTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

listTabsEnabledstringOptional

When true, list tabs are enabled.

listTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

noteTabsEnabledstringOptional

When true, note tabs are enabled.

noteTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

numericalTabsEnabledstringOptional
numericalTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

prefillTabsEnabledstringOptional
prefillTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

radioTabsEnabledstringOptional

When true, radio button tabs are enabled.

radioTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

savingCustomTabsEnabledstringOptional

When true, saving custom tabs is enabled.

savingCustomTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

senderToChangeTabAssignmentsEnabledstringOptional
Reserved for Docusign.
senderToChangeTabAssignmentsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

sharedCustomTabsEnabledstringOptional

When true, shared custom tabs are enabled.

sharedCustomTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabDataLabelEnabledstringOptional

When true, data labels are enabled.

Note: Only Admin users can change this setting.

tabDataLabelMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabLocationEnabledstringOptional
Reserved for Docusign.
tabLocationMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabLockingEnabledstringOptional

When true, tab locking is enabled.

Note: Only Admin users can change this setting.

tabLockingMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabScaleEnabledstringOptional
Reserved for Docusign.
tabScaleMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabTextFormattingEnabledstringOptional

When true, text formatting (such as font type, font size, font color, bold, italic, and underline) is enabled for tabs that support formatting.

Note: This property is read-only and cannot be used to be update the account settings

tabTextFormattingMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

textTabsEnabledstringOptional

When true, text tabs are enabled.

textTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

uriTabsEnabledstringOptional
uriTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

Response

Successful response.
allowTabOrderstringOptional

When true, account users can set a tab order for the signing process.

Note: Only Admin users can change this setting.

allowTabOrderMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

approveDeclineTabsEnabledstringOptional

When true, approve and decline tabs are enabled.

approveDeclineTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

calculatedFieldsEnabledstringOptional

When true, calculated fields are enabled for tabs.

calculatedFieldsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

checkboxTabsEnabledstringOptional

When true, checkbox tabs are enabled.

checkBoxTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

dataFieldRegexEnabledstringOptional

When true, regular expressions are enabled for tabs that contain data fields.

dataFieldRegexMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

dataFieldSizeEnabledstringOptional

When true, setting character limits for input fields is enabled.

dataFieldSizeMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

drawTabsEnabledstringOptional
drawTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

enableTabAgreementDetailsstringOptional
enableTabAgreementDetailsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

firstLastEmailTabsEnabledstringOptional
Reserved for Docusign.
firstLastEmailTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

listTabsEnabledstringOptional

When true, list tabs are enabled.

listTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

noteTabsEnabledstringOptional

When true, note tabs are enabled.

noteTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

numericalTabsEnabledstringOptional
numericalTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

prefillTabsEnabledstringOptional
prefillTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

radioTabsEnabledstringOptional

When true, radio button tabs are enabled.

radioTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

savingCustomTabsEnabledstringOptional

When true, saving custom tabs is enabled.

savingCustomTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

senderToChangeTabAssignmentsEnabledstringOptional
Reserved for Docusign.
senderToChangeTabAssignmentsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

sharedCustomTabsEnabledstringOptional

When true, shared custom tabs are enabled.

sharedCustomTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabDataLabelEnabledstringOptional

When true, data labels are enabled.

Note: Only Admin users can change this setting.

tabDataLabelMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabLocationEnabledstringOptional
Reserved for Docusign.
tabLocationMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabLockingEnabledstringOptional

When true, tab locking is enabled.

Note: Only Admin users can change this setting.

tabLockingMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabScaleEnabledstringOptional
Reserved for Docusign.
tabScaleMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

tabTextFormattingEnabledstringOptional

When true, text formatting (such as font type, font size, font color, bold, italic, and underline) is enabled for tabs that support formatting.

Note: This property is read-only and cannot be used to be update the account settings

tabTextFormattingMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

textTabsEnabledstringOptional

When true, text tabs are enabled.

textTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

uriTabsEnabledstringOptional
uriTabsMetadataobjectOptional

Metadata that indicates whether a property is editable and describes setting-specific options.

Errors

400
Bad Request Error