Request

HTTP request

PUT /v2/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

An error code associated with the error.

messagestring

A short error message.

settingsMetadata

is21CFRPart11string

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

options[array]

rightsstring

uiHintstring

uiOrderstring

uiTypestring

AccountTabSettings

allowTabOrderstring

allowTabOrderMetadatasettingsMetadata

approveDeclineTabsEnabledstring

approveDeclineTabsMetadatasettingsMetadata

calculatedFieldsEnabledstring

calculatedFieldsMetadatasettingsMetadata

checkboxTabsEnabledstring

checkboxTabsMetadatasettingsMetadata

dataFieldRegexEnabledstring

dataFieldRegexMetadatasettingsMetadata

dataFieldSizeEnabledstring

dataFieldSizeMetadatasettingsMetadata

firstLastEmailTabsEnabledstring

firstLastEmailTabsMetadatasettingsMetadata

listTabsEnabledstring

listTabsMetadatasettingsMetadata

noteTabsEnabledstring

noteTabsMetadatasettingsMetadata

radioTabsEnabledstring

radioTabsMetadatasettingsMetadata

savingCustomTabsEnabledstring

savingCustomTabsMetadatasettingsMetadata

senderToChangeTabAssignmentsEnabledstring

senderToChangeTabAssignmentsMetadatasettingsMetadata

sharedCustomTabsEnabledstring

sharedCustomTabsMetadatasettingsMetadata

tabDataLabelEnabledstring

tabDataLabelMetadatasettingsMetadata

tabLocationEnabledstring

tabLocationMetadatasettingsMetadata

tabLockingEnabledstring

tabLockingMetadatasettingsMetadata

tabScaleEnabledstring

tabScaleMetadatasettingsMetadata

tabTextFormattingEnabledstring

tabTextFormattingMetadatasettingsMetadata

textTabsEnabledstring

textTabsMetadatasettingsMetadata

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> 
}} />