Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Request Body

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::updateAccountTabSettings

Definitions Expand All | Collapse All

AccountTabSettings

allowTabOrder string
allowTabOrderMetadata settingsMetadata
approveDeclineTabsEnabled string
approveDeclineTabsMetadata settingsMetadata
calculatedFieldsEnabled string
calculatedFieldsMetadata settingsMetadata
checkboxTabsEnabled string
checkboxTabsMetadata settingsMetadata
dataFieldRegexEnabled string
dataFieldRegexMetadata settingsMetadata
dataFieldSizeEnabled string
dataFieldSizeMetadata settingsMetadata
firstLastEmailTabsEnabled string
firstLastEmailTabsMetadata settingsMetadata
listTabsEnabled string
listTabsMetadata settingsMetadata
noteTabsEnabled string
noteTabsMetadata settingsMetadata
radioTabsEnabled string
radioTabsMetadata settingsMetadata
savingCustomTabsEnabled string
savingCustomTabsMetadata settingsMetadata
senderToChangeTabAssignmentsEnabled string
senderToChangeTabAssignmentsMetadata settingsMetadata
sharedCustomTabsEnabled string
sharedCustomTabsMetadata settingsMetadata
tabDataLabelEnabled string
tabDataLabelMetadata settingsMetadata
tabLocationEnabled string
tabLocationMetadata settingsMetadata
tabLockingEnabled string
tabLockingMetadata settingsMetadata
tabScaleEnabled string
tabScaleMetadata settingsMetadata
tabTextFormattingEnabled string
tabTextFormattingMetadata settingsMetadata
textTabsEnabled string
textTabsMetadata settingsMetadata

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

settingsMetadata

is21CFRPart11 string

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

options
[string]
rights string
uiHint string
uiOrder string
uiType string

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>