DocuSign icon

DocuSign

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

Actions341

Envelope Recipient Tab → Update

AI-generated

Summary

Updates a specific tab for a recipient within an envelope.

Inputs

  • accountId (required) — The DocuSign Account ID (GUID).
  • envelopeId (required) — The ID (GUID) of the envelope containing the recipient and tab.
  • recipientId (required) — The ID of the recipient to update the tab for.
  • tabType (required) — The type of tab to update (e.g., signHereTabs, textTabs, checkboxTabs).
  • tabs — A fixed collection of tabs to update. Each tab can include placement, value, styling, validation, and conditional visibility settings.

Output shape

The updated tab object

The operation modifies a single tab on the specified recipient within the envelope. The returned data represents the updated tab properties.

Examples

Example 1: Update a Sign Here tab value and make it required for a specific recipient.

Set tabType to 'signHereTabs', recipientId to the signer's ID, and define the tab with a specific value and required flag.

Example 2: Move a text tab to a fixed position on a specific page.

Set tabType to 'textTabs', recipientId, and define the tab with placementMethod='fixed', documentId, and pageNumber.

Links

Discussion