DocuSign icon

DocuSign

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

Actions341

Envelope Custom Field → Create

AI-generated

Summary

Create custom field definitions on an envelope

Inputs

  • authentication — Authentication method (OAuth2 or JWT Service Integration)
  • category — API category to work with (e.g., envelopes, templates, account, users & groups)
  • accountId (required) — DocuSign Account ID (GUID). Find it in DocuSign Admin → API and Keys.
  • envelopeId (required) — ID (GUID) of the envelope to which the custom field will be added.
  • textCustomFields — Collection of text custom field definitions to add to the envelope.
  • listCustomFields — Collection of list custom field definitions to add to the envelope.

Output shape

a custom field definition object

May include fieldId, name, value, required, show; optional fields omitted; errors follow DocuSign error format.

Examples

Example 1: Add a text custom field to an envelope

Authentication: OAuth2; Category: Envelopes; Account ID: 12345678-90ab-cdef-1234-567890abcdef; Envelope ID: 1A2B3C4D-5678-90ab-cdef-1234567890ab; Text Custom Fields: [{Field ID: "123", Name: "Department", Value: "Finance", Required: Yes, Show: Yes}]

Example 2: Add a list custom field to an envelope

Authentication: JWT; Category: Envelopes; Account ID: 12345678-90ab-cdef-1234-567890abcdef; Envelope ID: 1A2B3C4D-5678-90ab-cdef-1234567890ab; List Custom Fields: [{Field: {Field ID: "456", Name: "Project", List Items: "Alpha;Beta;Gamma", Value: "Alpha", Required: Yes, Show: Yes}}]

Links

Discussion