docusign.custom-tabs.put-custom-tab

Updates the information in a custom tab for the specified account.

Updates custom tab information.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
customtabid	string	Yes	—	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.
anchor	string	No	—	An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
anchorcasesensitive	string	No	—	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: $~><
anchorhorizontalalignment	string	No	—	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	No	—	When true, this tab is ignored if the anchorString is not found in the document.
anchormatchwholeword	string	No	—	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: $~><
anchorunits	string	No	—	Specifies units of the anchorXOffset and anchorYOffset. Valid units are: - pixels (default) - inches - mms - cms
anchorxoffset	string	No	—	Specifies the X axis location of the tab in anchorUnits relative to the anchorString.
anchoryoffset	string	No	—	Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.
bold	string	No	—	When true, the information in the tab is bold.
collaborative	string	No	—	—
concealvalueondocument	string	No	—	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	No	—	The user name of the Docusign user who created this object.
createdbyuserid	string	No	—	The userId of the Docusign user who created this object.
customtabid_2	string	No	—	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	No	—	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	No	—	When true, the custom tab is editable. Otherwise the custom tab cannot be modified.
font	string	No	—	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	No	—	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	No	—	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	No	—	The height of the tab in pixels. Must be an integer.
includedinemail	string	No	—	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	No	—	The original value of the tab.
italic	string	No	—	When true, the information in the tab is italic.
items	list	No	—	If the tab is a list, this represents the values that are possible for the tab.
lastmodified	string	No	—	The UTC DateTime this object was last modified. This is in ISO 8601 format.
lastmodifiedbydisplayname	string	No	—	The User Name of the Docusign user who last modified this object.
lastmodifiedbyuserid	string	No	—	The userId of the Docusign user who last modified this object.
localepolicy	json	No	—	Allows you to customize locale settings.
locked	string	No	—	When true, the signer cannot change the data of the custom tab.
maximumlength	string	No	—	The maximum number of entry characters supported by the custom tab.
maxnumericalvalue	string	No	—	—
mergefield	json	No	—	Contains information for transferring values between Salesforce data fields and Docusign tabs.
minnumericalvalue	string	No	—	—
name	string	No	—	—
numericalvalue	string	No	—	—
paymentitemcode	string	No	—	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	No	—	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	No	—	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	No	—	When true and shared is true, information must be entered in this field to complete the envelope.
required	string	No	—	When true, the signer is required to fill out this tab.
requireinitialonsharedchange	string	No	—	Optional element for field markup. When true, the signer is required to initial when they modify a shared field.
scalevalue	string	No	—	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	No	—	When true, the radio button is selected.
shared	string	No	—	When true, this custom tab is shared.
signatureproviderid	string	No	—	Reserved for Docusign.
stamptype	string	No	—	The type of stamp. Valid values are: - signature: A signature image. This is the default value. - stamp: A stamp image. - null
stamptypemetadata	json	No	—	Metadata about a property.
tablabel	string	No	—	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	No	—	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	No	—	When true, the information in the tab is underlined.
validationmessage	string	No	—	The message displayed if the custom tab fails input validation (either custom of embedded).
validationpattern	string	No	—	A regular expression used to validate input for the tab.
validationtype	string	No	—	Specifies how numerical data is validated. Valid values: - number - currency
width	string	No	—	The width of the tab in pixels. Must be an integer.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
customtabid	string	Yes	—	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.
anchor	string	No	—	An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
anchorcasesensitive	string	No	—	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: $~><
anchorhorizontalalignment	string	No	—	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	No	—	When true, this tab is ignored if the anchorString is not found in the document.
anchormatchwholeword	string	No	—	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: $~><
anchorunits	string	No	—	Specifies units of the anchorXOffset and anchorYOffset. Valid units are: - pixels (default) - inches - mms - cms
anchorxoffset	string	No	—	Specifies the X axis location of the tab in anchorUnits relative to the anchorString.
anchoryoffset	string	No	—	Specifies the Y axis location of the tab in anchorUnits relative to the anchorString.
bold	string	No	—	When true, the information in the tab is bold.
collaborative	string	No	—	—
concealvalueondocument	string	No	—	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	No	—	The user name of the Docusign user who created this object.
createdbyuserid	string	No	—	The userId of the Docusign user who created this object.
customtabid_2	string	No	—	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	No	—	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	No	—	When true, the custom tab is editable. Otherwise the custom tab cannot be modified.
font	string	No	—	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	No	—	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	No	—	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	No	—	The height of the tab in pixels. Must be an integer.
includedinemail	string	No	—	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	No	—	The original value of the tab.
italic	string	No	—	When true, the information in the tab is italic.
items	list	No	—	If the tab is a list, this represents the values that are possible for the tab.
lastmodified	string	No	—	The UTC DateTime this object was last modified. This is in ISO 8601 format.
lastmodifiedbydisplayname	string	No	—	The User Name of the Docusign user who last modified this object.
lastmodifiedbyuserid	string	No	—	The userId of the Docusign user who last modified this object.
localepolicy	json	No	—	Allows you to customize locale settings.
locked	string	No	—	When true, the signer cannot change the data of the custom tab.
maximumlength	string	No	—	The maximum number of entry characters supported by the custom tab.
maxnumericalvalue	string	No	—	—
mergefield	json	No	—	Contains information for transferring values between Salesforce data fields and Docusign tabs.
minnumericalvalue	string	No	—	—
name	string	No	—	—
numericalvalue	string	No	—	—
paymentitemcode	string	No	—	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	No	—	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	No	—	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	No	—	When true and shared is true, information must be entered in this field to complete the envelope.
required	string	No	—	When true, the signer is required to fill out this tab.
requireinitialonsharedchange	string	No	—	Optional element for field markup. When true, the signer is required to initial when they modify a shared field.
scalevalue	string	No	—	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	No	—	When true, the radio button is selected.
shared	string	No	—	When true, this custom tab is shared.
signatureproviderid	string	No	—	Reserved for Docusign.
stamptype	string	No	—	The type of stamp. Valid values are: - signature: A signature image. This is the default value. - stamp: A stamp image. - null
stamptypemetadata	json	No	—	Metadata about a property.
tablabel	string	No	—	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	No	—	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	No	—	When true, the information in the tab is underlined.
validationmessage	string	No	—	The message displayed if the custom tab fails input validation (either custom of embedded).
validationpattern	string	No	—	A regular expression used to validate input for the tab.
validationtype	string	No	—	Specifies how numerical data is validated. Valid values: - number - currency
width	string	No	—	The width of the tab in pixels. Must be an integer.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/tab_definitions/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/tab_definitions/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.custom-tabs.put-custom-tab",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "customtabid": "value"
  }
}