---
title: "Creates a custom tab."
method: POST
path: "/v2.1/accounts/{accountId}/tab_definitions"
tags: ["CustomTabs"]
---

# Creates a custom tab.

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

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.

## Path parameters

- `accountId` string, required

## Request body

- TabMetadata
  - `anchor` string — An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
  - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
  - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
  - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document.
  - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
  - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
  - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
  - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
  - `bold` string — When **true,** the information in the tab is bold.
  - `collaborative` string
  - `concealValueOnDocument` string — When **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 only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
  - `createdByDisplayName` string — The user name of the Docusign user who created this object.
  - `createdByUserId` string — The userId of the Docusign user who created this object.
  - `customTabId` string — 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.
  - `disableAutoSize` string — When **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.
  - `editable` string — When **true,** the custom tab is editable. Otherwise the custom tab cannot be modified.
  - `font` string — 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
  - `fontColor` string — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
  - `fontSize` string — 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
  - `height` string — The height of the tab in pixels. Must be an integer.
  - `includedInEmail` string — When **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.
  - `initialValue` string — The original value of the tab.
  - `italic` string — When **true,** the information in the tab is italic.
  - `items` string[] — If the tab is a list, this represents the values that are possible for the tab.
  - `lastModified` string — The UTC DateTime this object was last modified. This is in ISO 8601 format.
  - `lastModifiedByDisplayName` string — The User Name of the Docusign user who last modified this object.
  - `lastModifiedByUserId` string — The userId of the Docusign user who last modified this object.
  - `localePolicy` LocalePolicyTab — Allows you to customize locale settings.
    - `addressFormat` string — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
    - `calendarType` string — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
    - `cultureName` string — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
    - `currencyCode` string — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL`
    - `currencyNegativeFormat` string — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
    - `currencyPositiveFormat` string — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
    - `customDateFormat` string
    - `customTimeFormat` string
    - `dateFormat` string — Specifies the date format. Valid values: - `default` <br> used the UI's - `longformat` <br> use the UI's long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
    - `initialFormat` string — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
    - `nameFormat` string — Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
    - `timeFormat` string — Specifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
    - `timeZone` string — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime`
    - `useLongCurrencyFormat` string — When **true,** use the long currency format for the locale.
  - `locked` string — When **true,** the signer cannot change the data of the custom tab.
  - `maximumLength` string — The maximum number of entry characters supported by the custom tab.
  - `maxNumericalValue` string
  - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs.
    - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process.
    - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property.
      - `options` string[] — An array of option strings supported by this setting.
      - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
    - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
    - `configurationTypeMetadata` PropertyMetadata — Metadata about a property.
      - `options` string[] — An array of option strings supported by this setting.
      - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
    - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object.
    - `pathExtended` PathExtendedElement[] — Reserved for Docusign.
      - `name` string
      - `type` string — 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`
      - `typeName` string
    - `pathExtendedMetadata` PropertyMetadata — Metadata about a property.
      - `options` string[] — An array of option strings supported by this setting.
      - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
    - `pathMetadata` PropertyMetadata — Metadata about a property.
      - `options` string[] — An array of option strings supported by this setting.
      - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
    - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to.
    - `rowMetadata` PropertyMetadata — Metadata about a property.
      - `options` string[] — An array of option strings supported by this setting.
      - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
    - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
    - `writeBackMetadata` PropertyMetadata — Metadata about a property.
      - `options` string[] — An array of option strings supported by this setting.
      - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
  - `minNumericalValue` string
  - `name` string
  - `numericalValue` string
  - `paymentItemCode` string — If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id. Example: `SHAK1` Maximum Length: 100 characters.
  - `paymentItemDescription` string — If the custom tab is for a payment request, this is the description of the item associated with the charge. Example: `The Danish play by Shakespeare` Maximum Length: 100 characters.
  - `paymentItemName` string — If the custom tab is for a payment request, this is the name of the item associated with the charge. Maximum Length: 100 characters. Example: `Hamlet`
  - `requireAll` string — When **true** and shared is true, information must be entered in this field to complete the envelope.
  - `required` string — When **true,** the signer is required to fill out this tab.
  - `requireInitialOnSharedChange` string — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.
  - `scaleValue` string — Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.
  - `selected` string — When **true,** the radio button is selected.
  - `shared` string — When **true,** this custom tab is shared.
  - `signatureProviderId` string — Reserved for Docusign.
  - `stampType` string — The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null
  - `stampTypeMetadata` PropertyMetadata — Metadata about a property.
    - `options` string[] — An array of option strings supported by this setting.
    - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
  - `tabLabel` string — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
  - `type` string — 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`
  - `underline` string — When **true,** the information in the tab is underlined.
  - `validationMessage` string — The message displayed if the custom tab fails input validation (either custom of embedded).
  - `validationPattern` string — A regular expression used to validate input for the tab.
  - `validationType` string — Specifies how numerical data is validated. Valid values: - `number` - `currency`
  - `width` string — The width of the tab in pixels. Must be an integer.

## Response `201`

Successful response.

## Other responses

- `400` — Error encountered.

---

[API](https://skmtc.net/docusign/apis/docusign-esignature-rest-api.md) · [All operations](https://skmtc.net/docusign/apis/docusign-esignature-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/docusign/docusign-esignature-rest-api/revisions/77f1998c313d/schema)