EnvelopeCustomFields Resource

The EnvelopeCustomFields resource provides methods that allow you manage custom fields in an envelope.

Custom fields can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.

There are two types of envelope custom fields:

  • text: Enables the sender to enter the value for the field.
  • list: Enables the sender to select the value of the field from a predetermined list.

You may assign up to three envelope custom fields to an envelope. This limit does not include account (document) custom fields.

GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Gets the custom field information for the specified envelope.

PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Updates envelope custom fields in an envelope.

POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Creates envelope custom fields for an envelope.

DELETE /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Deletes envelope custom fields for draft and in-process envelopes.

}} />