CustomTabs: create

Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.

Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Request

HTTP request

POST /v2.1/accounts/{accountId}/tab_definitions

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Request Body

CustomTabs

Responses

CodeDescriptionReference
201

Successful response.

CustomTabs
400

Error encountered.

errorDetails

SDK Method

CustomTabs::create

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.

mergeField

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

allowSenderToEditstring

When true, the sender can modify the value of the mergeField tab during the sending process.

allowSenderToEditMetadatapropertyMetadata

Metadata that indicates if the sender can edit the allowSenderToEdit property.

configurationTypestring

If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.

configurationTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the configurationType property.

pathstring

Sets the object associated with the custom tab. Currently this is the Salesforce Object.

pathExtended[pathExtendedElement]

Reserved for DocuSign.

pathExtendedMetadatapropertyMetadata

Reserved for DocuSign.

pathMetadatapropertyMetadata

Metadata that indicates whether the path property is editable.

rowstring

Specifies the row number in a Salesforce table that the merge field value corresponds to.

rowMetadatapropertyMetadata

Metadata that indicates whether the row property is editable.

writeBackstring

When true, data entered into the merge field during Signing will update the mapped Salesforce field.

writeBackMetadatapropertyMetadata

Metadata that indicates if the sender can edit the writeBack property.

pathExtendedElement

namestring

typestring

Type of user:

  • type_owner
  • type_participant

typeNamestring

propertyMetadata

Metadata about a property.

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

CustomTabs

Custom tabs

anchorstring

An optional string that is used to auto-match tabs to strings located in the documents of an envelope.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

createdByDisplayNamestring

The user name of the DocuSign user who created this object.

createdByUserIdstring

The userId of the DocuSign user who created this object.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

editablestring

When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified.

fontstring

The font to be used for the tab value. Supported fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

heightstring

The height of the tab in pixels.

includedInEmailstring

When set to true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.

initialValuestring

The original value of the tab.

italicstring

When set to true, the information in the tab is italic.

items[array]

If the tab is a list, this represents the values that are possible for the tab.

lastModifiedstring

The UTC DateTime this object was last modified. This is in ISO8601 format.

lastModifiedByDisplayNamestring

The User Name of the DocuSign user who last modified this object.

lastModifiedByUserIdstring

The userId of the DocuSign user who last modified this object.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maximumLengthstring

The maximum number of entry characters supported by the custom tab.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

paymentItemCodestring

paymentItemDescriptionstring

paymentItemNamestring

requiredstring

When set to true, the signer is required to fill out this tab.

scaleValuestring

A value of 1 indicates 100% of normal tab size.

selectedstring

When set to true, the radio button is selected.

sharedstring

When set to true, this custom tab is shared.

stampTypestring

If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.

stampTypeMetadatapropertyMetadata

Metadata that indicates whether the stampType property is editable.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

typestring

The type of this tab. Values are:

  • Approve
  • CheckBox
  • Company
  • Date
  • DateSigned, Decline
  • Email, EmailAddress
  • EnvelopeId
  • FirstName
  • Formula
  • FullName, InitialHere
  • InitialHereOptional
  • LastName
  • List
  • Note
  • Number
  • Radio
  • SignerAttachment
  • SignHere
  • SignHereOptional
  • Ssn
  • Text
  • Title
  • Zip5
  • Zip5Dash4

underlinestring

When set to true, the information in the tab is underlined.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPatternstring

A regular expression used to validate input for the tab.

widthstring

The width of the tab in pixels.

Examples

Generic JSON Request/Response

Request
{
  "font": "sample string 1",
  "bold": "sample string 2",
  "italic": "sample string 3",
  "underline": "sample string 4",
  "fontColor": "sample string 5",
  "fontSize": "sample string 6",
  "anchor": "sample string 7",
  "anchorXOffset": "sample string 8",
  "anchorYOffset": "sample string 9",
  "anchorUnits": "sample string 10",
  "anchorIgnoreIfNotPresent": "sample string 11",
  "anchorMatchWholeWord": "sample string 12",
  "anchorCaseSensitive": "sample string 13",
  "anchorHorizontalAlignment": "sample string 14",
  "paymentItemCode": "sample string 15",
  "paymentItemDescription": "sample string 16",
  "paymentItemName": "sample string 17",
  "height": "sample string 18",
  "width": "sample string 19",
  "customTabId": "sample string 20",
  "initialValue": "sample string 21",
  "includedInEmail": "sample string 22",
  "disableAutoSize": "sample string 23",
  "concealValueOnDocument": "sample string 24",
  "locked": "sample string 25",
  "required": "sample string 26",
  "shared": "sample string 27",
  "items": [
    "sample string 1"
  ],
  "tabLabel": "sample string 28",
  "maximumLength": "sample string 29",
  "scaleValue": "sample string 30",
  "name": "sample string 31",
  "type": "sample string 32",
  "validationMessage": "sample string 33",
  "validationPattern": "sample string 34",
  "lastModifiedByUserId": "sample string 35",
  "lastModifiedByDisplayName": "sample string 36",
  "lastModified": "sample string 37",
  "createdByUserId": "sample string 38",
  "createdByDisplayName": "sample string 39",
  "editable": "sample string 40",
  "mergeField": {
    "configurationType": "sample string 1",
    "path": "sample string 2",
    "writeBack": "sample string 3",
    "allowSenderToEdit": "sample string 4",
    "row": "sample string 5"
  },
  "stampType": "sample string 41"
}
Response
{
  "font": "sample string 1",
  "bold": "sample string 2",
  "italic": "sample string 3",
  "underline": "sample string 4",
  "fontColor": "sample string 5",
  "fontSize": "sample string 6",
  "anchor": "sample string 7",
  "anchorXOffset": "sample string 8",
  "anchorYOffset": "sample string 9",
  "anchorUnits": "sample string 10",
  "anchorIgnoreIfNotPresent": "sample string 11",
  "anchorMatchWholeWord": "sample string 12",
  "anchorCaseSensitive": "sample string 13",
  "anchorHorizontalAlignment": "sample string 14",
  "paymentItemCode": "sample string 15",
  "paymentItemDescription": "sample string 16",
  "paymentItemName": "sample string 17",
  "height": "sample string 18",
  "width": "sample string 19",
  "customTabId": "sample string 20",
  "initialValue": "sample string 21",
  "includedInEmail": "sample string 22",
  "disableAutoSize": "sample string 23",
  "concealValueOnDocument": "sample string 24",
  "locked": "sample string 25",
  "required": "sample string 26",
  "shared": "sample string 27",
  "items": [
    "sample string 1"
  ],
  "tabLabel": "sample string 28",
  "maximumLength": "sample string 29",
  "scaleValue": "sample string 30",
  "name": "sample string 31",
  "type": "sample string 32",
  "validationMessage": "sample string 33",
  "validationPattern": "sample string 34",
  "lastModifiedByUserId": "sample string 35",
  "lastModifiedByDisplayName": "sample string 36",
  "lastModified": "sample string 37",
  "createdByUserId": "sample string 38",
  "createdByDisplayName": "sample string 39",
  "editable": "sample string 40",
  "mergeField": {
    "configurationType": "sample string 1",
    "path": "sample string 2",
    "writeBack": "sample string 3",
    "allowSenderToEdit": "sample string 4",
    "row": "sample string 5"
  },
  "stampType": "sample string 41",
  "stampTypeMetadata": {
    "rights": "sample string 1",
    "options": [
      "sample string 1"
    ]
  }
}
Generic XML Request/Response

Request
<tabMetadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <anchor>sample string 7</anchor>
  <anchorCaseSensitive>sample string 13</anchorCaseSensitive>
  <anchorHorizontalAlignment>sample string 14</anchorHorizontalAlignment>
  <anchorIgnoreIfNotPresent>sample string 11</anchorIgnoreIfNotPresent>
  <anchorMatchWholeWord>sample string 12</anchorMatchWholeWord>
  <anchorUnits>sample string 10</anchorUnits>
  <anchorXOffset>sample string 8</anchorXOffset>
  <anchorYOffset>sample string 9</anchorYOffset>
  <bold>sample string 2</bold>
  <concealValueOnDocument>sample string 24</concealValueOnDocument>
  <createdByDisplayName>sample string 39</createdByDisplayName>
  <createdByUserId>sample string 38</createdByUserId>
  <customTabId>sample string 20</customTabId>
  <disableAutoSize>sample string 23</disableAutoSize>
  <editable>sample string 40</editable>
  <font>sample string 1</font>
  <fontColor>sample string 5</fontColor>
  <fontSize>sample string 6</fontSize>
  <height>sample string 18</height>
  <includedInEmail>sample string 22</includedInEmail>
  <initialValue>sample string 21</initialValue>
  <italic>sample string 3</italic>
  <items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
  </items>
  <lastModified>sample string 37</lastModified>
  <lastModifiedByDisplayName>sample string 36</lastModifiedByDisplayName>
  <lastModifiedByUserId>sample string 35</lastModifiedByUserId>
  <locked>sample string 25</locked>
  <maximumLength>sample string 29</maximumLength>
  <mergeField>
    <allowSenderToEdit>sample string 4</allowSenderToEdit>
    <configurationType>sample string 1</configurationType>
    <path>sample string 2</path>
    <row>sample string 5</row>
    <writeBack>sample string 3</writeBack>
  </mergeField>
  <name>sample string 31</name>
  <paymentItemCode>sample string 15</paymentItemCode>
  <paymentItemDescription>sample string 16</paymentItemDescription>
  <paymentItemName>sample string 17</paymentItemName>
  <required>sample string 26</required>
  <scaleValue>sample string 30</scaleValue>
  <shared>sample string 27</shared>
  <stampType>sample string 41</stampType>
  <tabLabel>sample string 28</tabLabel>
  <type>sample string 32</type>
  <underline>sample string 4</underline>
  <validationMessage>sample string 33</validationMessage>
  <validationPattern>sample string 34</validationPattern>
  <width>sample string 19</width>
</tabMetadata> 
Response
<tabMetadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <anchor>sample string 7</anchor>
  <anchorCaseSensitive>sample string 13</anchorCaseSensitive>
  <anchorHorizontalAlignment>sample string 14</anchorHorizontalAlignment>
  <anchorIgnoreIfNotPresent>sample string 11</anchorIgnoreIfNotPresent>
  <anchorMatchWholeWord>sample string 12</anchorMatchWholeWord>
  <anchorUnits>sample string 10</anchorUnits>
  <anchorXOffset>sample string 8</anchorXOffset>
  <anchorYOffset>sample string 9</anchorYOffset>
  <bold>sample string 2</bold>
  <concealValueOnDocument>sample string 24</concealValueOnDocument>
  <createdByDisplayName>sample string 39</createdByDisplayName>
  <createdByUserId>sample string 38</createdByUserId>
  <customTabId>sample string 20</customTabId>
  <disableAutoSize>sample string 23</disableAutoSize>
  <editable>sample string 40</editable>
  <font>sample string 1</font>
  <fontColor>sample string 5</fontColor>
  <fontSize>sample string 6</fontSize>
  <height>sample string 18</height>
  <includedInEmail>sample string 22</includedInEmail>
  <initialValue>sample string 21</initialValue>
  <italic>sample string 3</italic>
  <items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
  </items>
  <lastModified>sample string 37</lastModified>
  <lastModifiedByDisplayName>sample string 36</lastModifiedByDisplayName>
  <lastModifiedByUserId>sample string 35</lastModifiedByUserId>
  <locked>sample string 25</locked>
  <maximumLength>sample string 29</maximumLength>
  <mergeField>
    <allowSenderToEdit>sample string 4</allowSenderToEdit>
    <configurationType>sample string 1</configurationType>
    <path>sample string 2</path>
    <row>sample string 5</row>
    <writeBack>sample string 3</writeBack>
  </mergeField>
  <name>sample string 31</name>
  <paymentItemCode>sample string 15</paymentItemCode>
  <paymentItemDescription>sample string 16</paymentItemDescription>
  <paymentItemName>sample string 17</paymentItemName>
  <required>sample string 26</required>
  <scaleValue>sample string 30</scaleValue>
  <shared>sample string 27</shared>
  <stampType>sample string 41</stampType>
  <stampTypeMetadata>
    <options>
      <string>sample string 1</string>
    </options>
    <rights>sample string 1</rights>
  </stampTypeMetadata>
  <tabLabel>sample string 28</tabLabel>
  <type>sample string 32</type>
  <underline>sample string 4</underline>
  <validationMessage>sample string 33</validationMessage>
  <validationPattern>sample string 34</validationPattern>
  <width>sample string 19</width>
</tabMetadata> 
}} />