DocuSign icon

DocuSign

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

Actions341

Envelope Custom Field → Update

AI-generated

Summary

Update envelope custom field details

Inputs

  • authentication (required) — DocuSign authentication method (OAuth2 or JWT) to use for the request.
  • accountId (required) — The DocuSign Account ID (GUID) for the account where the envelope is located.
  • envelopeId (required) — The ID (GUID) of the envelope containing the custom field to update.
  • category — API category to work with; defaults to "envelopes".
  • textCustomFields — Array of text custom field definitions to update (each includes fieldId, name, value, required, show).
  • listCustomFields — Array of list custom field definitions to update (each includes fieldId, name, listItems, value, required, show).

Output shape

a single updated envelope custom field object

Response contains the updated field metadata; errors are returned as DocuSign error envelopes.

Examples

Example 1: Add a text field to an existing envelope

authentication=oauth2|accountId=12345678-90ab-cdef-1234-567890abcdef|envelopeId=abcd1234-ef56-7890-abcd-1234567890ab|textCustomFields=[{fieldId=8a9b0c1d, name=Department, value=Finance, required=false, show=true}]

Example 2: Update a list field's selected value

authentication=jwt|accountId=12345678-90ab-cdef-1234-567890abcdef|envelopeId=abcd1234-ef56-7890-abcd-1234567890ab|listCustomFields=[{fieldId=2e3f4g5h, name=Priority, value=High, required=true, show=true}]

Links

Discussion