docusign.account-tab-settings.put-settings

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

Modifies tab settings for specified account

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
allowtaborder	string	No	—	When true, account users can set a tab order for the signing process. Note: Only Admin users can change this setting.
allowtabordermetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
approvedeclinetabsenabled	string	No	—	When true, approve and decline tabs are enabled.
approvedeclinetabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
calculatedfieldsenabled	string	No	—	When true, calculated fields are enabled for tabs.
calculatedfieldsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
checkboxtabsenabled	string	No	—	When true, checkbox tabs are enabled.
checkboxtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
datafieldregexenabled	string	No	—	When true, regular expressions are enabled for tabs that contain data fields.
datafieldregexmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
datafieldsizeenabled	string	No	—	When true, setting character limits for input fields is enabled.
datafieldsizemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
drawtabsenabled	string	No	—	—
drawtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enabletabagreementdetails	string	No	—	—
enabletabagreementdetailsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
firstlastemailtabsenabled	string	No	—	Reserved for Docusign.
firstlastemailtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
listtabsenabled	string	No	—	When true, list tabs are enabled.
listtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
notetabsenabled	string	No	—	When true, note tabs are enabled.
notetabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
numericaltabsenabled	string	No	—	—
numericaltabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
prefilltabsenabled	string	No	—	—
prefilltabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
radiotabsenabled	string	No	—	When true, radio button tabs are enabled.
radiotabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
savingcustomtabsenabled	string	No	—	When true, saving custom tabs is enabled.
savingcustomtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
sendertochangetabassignmentsenabled	string	No	—	Reserved for Docusign.
sendertochangetabassignmentsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
sharedcustomtabsenabled	string	No	—	When true, shared custom tabs are enabled.
sharedcustomtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tabdatalabelenabled	string	No	—	When true, data labels are enabled. Note: Only Admin users can change this setting.
tabdatalabelmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tablocationenabled	string	No	—	Reserved for Docusign.
tablocationmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tablockingenabled	string	No	—	When true, tab locking is enabled. Note: Only Admin users can change this setting.
tablockingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tabscaleenabled	string	No	—	Reserved for Docusign.
tabscalemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tabtextformattingenabled	string	No	—	When true, text formatting (such as font type, font size, font color, bold, italic, and underline) is enabled for tabs that support formatting. Note: Only Admin users can change this setting.
tabtextformattingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
texttabsenabled	string	No	—	When true, text tabs are enabled.
texttabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
uritabsenabled	string	No	—	—
uritabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
allowtaborder	string	No	—	When true, account users can set a tab order for the signing process. Note: Only Admin users can change this setting.
allowtabordermetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
approvedeclinetabsenabled	string	No	—	When true, approve and decline tabs are enabled.
approvedeclinetabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
calculatedfieldsenabled	string	No	—	When true, calculated fields are enabled for tabs.
calculatedfieldsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
checkboxtabsenabled	string	No	—	When true, checkbox tabs are enabled.
checkboxtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
datafieldregexenabled	string	No	—	When true, regular expressions are enabled for tabs that contain data fields.
datafieldregexmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
datafieldsizeenabled	string	No	—	When true, setting character limits for input fields is enabled.
datafieldsizemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
drawtabsenabled	string	No	—	—
drawtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enabletabagreementdetails	string	No	—	—
enabletabagreementdetailsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
firstlastemailtabsenabled	string	No	—	Reserved for Docusign.
firstlastemailtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
listtabsenabled	string	No	—	When true, list tabs are enabled.
listtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
notetabsenabled	string	No	—	When true, note tabs are enabled.
notetabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
numericaltabsenabled	string	No	—	—
numericaltabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
prefilltabsenabled	string	No	—	—
prefilltabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
radiotabsenabled	string	No	—	When true, radio button tabs are enabled.
radiotabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
savingcustomtabsenabled	string	No	—	When true, saving custom tabs is enabled.
savingcustomtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
sendertochangetabassignmentsenabled	string	No	—	Reserved for Docusign.
sendertochangetabassignmentsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
sharedcustomtabsenabled	string	No	—	When true, shared custom tabs are enabled.
sharedcustomtabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tabdatalabelenabled	string	No	—	When true, data labels are enabled. Note: Only Admin users can change this setting.
tabdatalabelmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tablocationenabled	string	No	—	Reserved for Docusign.
tablocationmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tablockingenabled	string	No	—	When true, tab locking is enabled. Note: Only Admin users can change this setting.
tablockingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tabscaleenabled	string	No	—	Reserved for Docusign.
tabscalemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
tabtextformattingenabled	string	No	—	When true, text formatting (such as font type, font size, font color, bold, italic, and underline) is enabled for tabs that support formatting. Note: Only Admin users can change this setting.
tabtextformattingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
texttabsenabled	string	No	—	When true, text tabs are enabled.
texttabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
uritabsenabled	string	No	—	—
uritabsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/settings/tabs
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/settings/tabs
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.account-tab-settings.put-settings",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}