DocuSign icon

DocuSign

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

Actions341

Account Custom Field → Update

AI-generated

Summary

Updates a DocuSign account custom field identified by its customFieldId. The operation uses the specified authentication method and API category, and allows optional updates to the field's type, name, and additional properties (required, visibility, default value, list items).

Inputs

  • authentication — Authentication method for DocuSign API access. Defaults to OAuth2; JWT (Service Integration) is also available.
  • category — API category scoping the custom field management. Defaults to 'envelopes'. Select from Envelopes, Templates, Account, Users & Groups, Billing, Connect, Folders, Signing Groups, PowerForms, Bulk Operations, Workspaces, or Advanced.
  • accountId (required) — The DocuSign Account ID (GUID). Retrieve from DocuSign Admin → API and Keys.
  • customFieldId (required) — The ID of the custom field to update.
  • fieldType (required) — The type of custom field. Choose 'Text' for single-line text or 'List' for multiple-select options.
  • name (required) — The display name of the custom field.
  • additionalFields — Optional collection to configure field visibility and defaults. Sub-options: 'required' (Yes/No), 'show' (Yes/No), 'value' (default string), 'listItems' (semicolon-separated values for list-type fields, shown when fieldType is 'List').

Output shape

The DocuSign API returns the updated custom field resource object reflecting the changes applied.

The operation sends a PATCH request to /accounts/{accountId}/custom_fields/{customFieldId} (or equivalent DocuSign endpoint) using the configured authentication. All parameter values are passed as-is; unspecified optional fields retain their existing DocuSign values.

Examples

Example 1: Update a text-type custom field named 'Preferred Contact Method' on account '12345678-1234-1234-1234-123456789012' using OAuth2.

authentication: oAuth2; accountId: 12345678-1234-1234-1234-123456789012; customFieldId: cf_abc123; fieldType: text; name: Preferred Contact Method

Links

Discussion