Request

HTTP request

PUT /v2.1/accounts/{accountId}/settings/tabs

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Request Body

AccountTabSettings

Responses

CodeDescriptionReference
200

Successful response.

AccountTabSettings
400

Error encountered.

errorDetails

SDK Method

Accounts::updateAccountTabSettings

Definitions

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

settingsMetadata

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

is21CFRPart11string

When set to true, indicates that this module is enabled on the account.

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

uiHintstring

Reserved for DocuSign.

uiOrderstring

Reserved for DocuSign.

uiTypestring

Reserved for DocuSign.

AccountTabSettings

allowTabOrderstring

allowTabOrderMetadatasettingsMetadata

Metadata that indicates whether the allowTabOrder property is editable.

approveDeclineTabsEnabledstring

approveDeclineTabsMetadatasettingsMetadata

Metadata that indicates whether the approveDeclineTabs property is editable.

calculatedFieldsEnabledstring

calculatedFieldsMetadatasettingsMetadata

Metadata that indicates whether the calculatedFields property is editable.

checkboxTabsEnabledstring

checkBoxTabsMetadatasettingsMetadata

dataFieldRegexEnabledstring

dataFieldRegexMetadatasettingsMetadata

Metadata that indicates whether the dataFieldRegex property is editable.

dataFieldSizeEnabledstring

dataFieldSizeMetadatasettingsMetadata

Metadata that indicates whether the dataFieldSize property is editable.

firstLastEmailTabsEnabledstring

firstLastEmailTabsMetadatasettingsMetadata

Metadata that indicates whether the firstLastEmailTabs property is editable.

listTabsEnabledstring

listTabsMetadatasettingsMetadata

Metadata that indicates whether the listTabs property is editable.

noteTabsEnabledstring

noteTabsMetadatasettingsMetadata

Metadata that indicates whether the noteTabs property is editable.

radioTabsEnabledstring

radioTabsMetadatasettingsMetadata

Metadata that indicates whether the radioTabs property is editable.

savingCustomTabsEnabledstring

savingCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the savingCustomTabs property is editable.

senderToChangeTabAssignmentsEnabledstring

senderToChangeTabAssignmentsMetadatasettingsMetadata

Metadata that indicates whether the senderToChangeTabAssignments property is editable.

sharedCustomTabsEnabledstring

sharedCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the sharedCustomTabs property is editable.

tabDataLabelEnabledstring

tabDataLabelMetadatasettingsMetadata

Metadata that indicates whether the tabDataLabel property is editable.

tabLocationEnabledstring

tabLocationMetadatasettingsMetadata

Metadata that indicates whether the tabLocation property is editable.

tabLockingEnabledstring

tabLockingMetadatasettingsMetadata

Metadata that indicates whether the tabLocking property is editable.

tabScaleEnabledstring

tabScaleMetadatasettingsMetadata

Metadata that indicates whether the tabScale property is editable.

tabTextFormattingEnabledstring

tabTextFormattingMetadatasettingsMetadata

Metadata that indicates whether the tabTextFormatting property is editable.

textTabsEnabledstring

textTabsMetadatasettingsMetadata

Metadata that indicates whether the textTabs property is editable.

Examples

Generic JSON Request/Response

Request
{
  "textTabsEnabled": "sample string 1",
  "textTabsMetadata": {
    "rights": "sample string 1",
    "uiHint": "sample string 2",
    "uiType": "sample string 3",
    "uiOrder": "sample string 4",
    "is21CFRPart11": "sample string 5",
    "options": [
      "sample string 1"
    ]
  },
  "radioTabsEnabled": "sample string 2",
  "radioTabsMetadata": {},
  "checkboxTabsEnabled": "sample string 3",
  "checkboxTabsMetadata": {},
  "listTabsEnabled": "sample string 4",
  "listTabsMetadata": {},
  "approveDeclineTabsEnabled": "sample string 5",
  "approveDeclineTabsMetadata": {},
  "noteTabsEnabled": "sample string 6",
  "noteTabsMetadata": {},
  "dataFieldRegexEnabled": "sample string 7",
  "dataFieldRegexMetadata": {},
  "dataFieldSizeEnabled": "sample string 8",
  "dataFieldSizeMetadata": {},
  "tabLocationEnabled": "sample string 9",
  "tabLocationMetadata": {},
  "tabScaleEnabled": "sample string 10",
  "tabScaleMetadata": {},
  "tabLockingEnabled": "sample string 11",
  "tabLockingMetadata": {},
  "savingCustomTabsEnabled": "sample string 12",
  "savingCustomTabsMetadata": {},
  "tabTextFormattingEnabled": "sample string 13",
  "tabTextFormattingMetadata": {},
  "sharedCustomTabsEnabled": "sample string 14",
  "sharedCustomTabsMetadata": {},
  "senderToChangeTabAssignmentsEnabled": "sample string 15",
  "senderToChangeTabAssignmentsMetadata": {},
  "tabDataLabelEnabled": "sample string 16",
  "tabDataLabelMetadata": {},
  "firstLastEmailTabsEnabled": "sample string 17",
  "firstLastEmailTabsMetadata": {},
  "calculatedFieldsEnabled": "sample string 18",
  "calculatedFieldsMetadata": {},
  "allowTabOrder": "sample string 19",
  "allowTabOrderMetadata": {}
}
Response
{
  "textTabsEnabled": "sample string 1",
  "textTabsMetadata": {
    "rights": "sample string 1",
    "uiHint": "sample string 2",
    "uiType": "sample string 3",
    "uiOrder": "sample string 4",
    "is21CFRPart11": "sample string 5",
    "options": [
      "sample string 1"
    ]
  },
  "radioTabsEnabled": "sample string 2",
  "radioTabsMetadata": {},
  "checkboxTabsEnabled": "sample string 3",
  "checkboxTabsMetadata": {},
  "listTabsEnabled": "sample string 4",
  "listTabsMetadata": {},
  "approveDeclineTabsEnabled": "sample string 5",
  "approveDeclineTabsMetadata": {},
  "noteTabsEnabled": "sample string 6",
  "noteTabsMetadata": {},
  "dataFieldRegexEnabled": "sample string 7",
  "dataFieldRegexMetadata": {},
  "dataFieldSizeEnabled": "sample string 8",
  "dataFieldSizeMetadata": {},
  "tabLocationEnabled": "sample string 9",
  "tabLocationMetadata": {},
  "tabScaleEnabled": "sample string 10",
  "tabScaleMetadata": {},
  "tabLockingEnabled": "sample string 11",
  "tabLockingMetadata": {},
  "savingCustomTabsEnabled": "sample string 12",
  "savingCustomTabsMetadata": {},
  "tabTextFormattingEnabled": "sample string 13",
  "tabTextFormattingMetadata": {},
  "sharedCustomTabsEnabled": "sample string 14",
  "sharedCustomTabsMetadata": {},
  "senderToChangeTabAssignmentsEnabled": "sample string 15",
  "senderToChangeTabAssignmentsMetadata": {},
  "tabDataLabelEnabled": "sample string 16",
  "tabDataLabelMetadata": {},
  "firstLastEmailTabsEnabled": "sample string 17",
  "firstLastEmailTabsMetadata": {},
  "calculatedFieldsEnabled": "sample string 18",
  "calculatedFieldsMetadata": {},
  "allowTabOrder": "sample string 19",
  "allowTabOrderMetadata": {}
}
Generic XML Request/Response

Request
<tabAccountSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <allowTabOrder>sample string 19</allowTabOrder>
  <allowTabOrderMetadata />
  <approveDeclineTabsEnabled>sample string 5</approveDeclineTabsEnabled>
  <approveDeclineTabsMetadata />
  <calculatedFieldsEnabled>sample string 18</calculatedFieldsEnabled>
  <calculatedFieldsMetadata />
  <checkboxTabsEnabled>sample string 3</checkboxTabsEnabled>
  <checkboxTabsMetadata />
  <dataFieldRegexEnabled>sample string 7</dataFieldRegexEnabled>
  <dataFieldRegexMetadata />
  <dataFieldSizeEnabled>sample string 8</dataFieldSizeEnabled>
  <dataFieldSizeMetadata />
  <firstLastEmailTabsEnabled>sample string 17</firstLastEmailTabsEnabled>
  <firstLastEmailTabsMetadata />
  <listTabsEnabled>sample string 4</listTabsEnabled>
  <listTabsMetadata />
  <noteTabsEnabled>sample string 6</noteTabsEnabled>
  <noteTabsMetadata />
  <radioTabsEnabled>sample string 2</radioTabsEnabled>
  <radioTabsMetadata />
  <savingCustomTabsEnabled>sample string 12</savingCustomTabsEnabled>
  <savingCustomTabsMetadata />
  <senderToChangeTabAssignmentsEnabled>sample string 15</senderToChangeTabAssignmentsEnabled>
  <senderToChangeTabAssignmentsMetadata />
  <sharedCustomTabsEnabled>sample string 14</sharedCustomTabsEnabled>
  <sharedCustomTabsMetadata />
  <tabDataLabelEnabled>sample string 16</tabDataLabelEnabled>
  <tabDataLabelMetadata />
  <tabLocationEnabled>sample string 9</tabLocationEnabled>
  <tabLocationMetadata />
  <tabLockingEnabled>sample string 11</tabLockingEnabled>
  <tabLockingMetadata />
  <tabScaleEnabled>sample string 10</tabScaleEnabled>
  <tabScaleMetadata />
  <tabTextFormattingEnabled>sample string 13</tabTextFormattingEnabled>
  <tabTextFormattingMetadata />
  <textTabsEnabled>sample string 1</textTabsEnabled>
  <textTabsMetadata>
    <is21CFRPart11>sample string 5</is21CFRPart11>
    <options>
      <string>sample string 1</string>
    </options>
    <rights>sample string 1</rights>
    <uiHint>sample string 2</uiHint>
    <uiOrder>sample string 4</uiOrder>
    <uiType>sample string 3</uiType>
  </textTabsMetadata>
</tabAccountSettings> 
Response
<tabAccountSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <allowTabOrder>sample string 19</allowTabOrder>
  <allowTabOrderMetadata />
  <approveDeclineTabsEnabled>sample string 5</approveDeclineTabsEnabled>
  <approveDeclineTabsMetadata />
  <calculatedFieldsEnabled>sample string 18</calculatedFieldsEnabled>
  <calculatedFieldsMetadata />
  <checkboxTabsEnabled>sample string 3</checkboxTabsEnabled>
  <checkboxTabsMetadata />
  <dataFieldRegexEnabled>sample string 7</dataFieldRegexEnabled>
  <dataFieldRegexMetadata />
  <dataFieldSizeEnabled>sample string 8</dataFieldSizeEnabled>
  <dataFieldSizeMetadata />
  <firstLastEmailTabsEnabled>sample string 17</firstLastEmailTabsEnabled>
  <firstLastEmailTabsMetadata />
  <listTabsEnabled>sample string 4</listTabsEnabled>
  <listTabsMetadata />
  <noteTabsEnabled>sample string 6</noteTabsEnabled>
  <noteTabsMetadata />
  <radioTabsEnabled>sample string 2</radioTabsEnabled>
  <radioTabsMetadata />
  <savingCustomTabsEnabled>sample string 12</savingCustomTabsEnabled>
  <savingCustomTabsMetadata />
  <senderToChangeTabAssignmentsEnabled>sample string 15</senderToChangeTabAssignmentsEnabled>
  <senderToChangeTabAssignmentsMetadata />
  <sharedCustomTabsEnabled>sample string 14</sharedCustomTabsEnabled>
  <sharedCustomTabsMetadata />
  <tabDataLabelEnabled>sample string 16</tabDataLabelEnabled>
  <tabDataLabelMetadata />
  <tabLocationEnabled>sample string 9</tabLocationEnabled>
  <tabLocationMetadata />
  <tabLockingEnabled>sample string 11</tabLockingEnabled>
  <tabLockingMetadata />
  <tabScaleEnabled>sample string 10</tabScaleEnabled>
  <tabScaleMetadata />
  <tabTextFormattingEnabled>sample string 13</tabTextFormattingEnabled>
  <tabTextFormattingMetadata />
  <textTabsEnabled>sample string 1</textTabsEnabled>
  <textTabsMetadata>
    <is21CFRPart11>sample string 5</is21CFRPart11>
    <options>
      <string>sample string 1</string>
    </options>
    <rights>sample string 1</rights>
    <uiHint>sample string 2</uiHint>
    <uiOrder>sample string 4</uiOrder>
    <uiType>sample string 3</uiType>
  </textTabsMetadata>
</tabAccountSettings> 
}} />