DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Custom Tab → Update

AI-generated

Summary

Update a custom tab definition for a specified category and account.

Inputs

  • authentication — Authentication method to use (OAuth2 or JWT Service Integration).
  • category — API category to work with (e.g., Envelopes, Templates, Account, Users & Groups, Billing, Connect, Folders, Signing Groups, PowerForms, Bulk Operations, Advanced).
  • accountId (required) — DocuSign Account ID (GUID). Find it in DocuSign Admin → API and Keys.
  • customTabId (required) — The ID of the custom tab definition.
  • requestBody (required) — The custom tab definition as JSON, including fields like tabLabel, type, font, fontColor, fontSize, bold, italic, underline, height, width, maxLength, validationPattern, validationMessage, required, locked, concealValueOnDocument, disableAutoSize, items (for list type), anchor, anchorXOffset, anchorYOffset, anchorUnits.

Output shape

a single custom tab object

Returns the updated custom tab definition; successful calls return the updated object, failures are wrapped in an error envelope.

Examples

Example 1: Update a custom tab in the Envelopes category for account 12345 with ID 67890 using OAuth2 and a simple JSON body.

authentication=oAuth2, category=envelopes, accountId=12345, customTabId=67890, requestBody={"tabLabel":"MyTab","type":"text"}

Example 2: Update a custom tab in the Advanced category using JWT authentication.

authentication=jwt, category=advanced, accountId=112233, customTabId=445566, requestBody={"tabLabel":"SignatureArea","type":"signature","fontSize":12}

Example 3: Update a custom tab with list type to add options.

authentication=oAuth2, category=envelopes, accountId=998877, customTabId=112233, requestBody={"type":"list","items":[{"tabLabel":"Option1"},{"tabLabel":"Option2"}],"options":["A","B"]}

Links

Discussion