Add Custom Envelope Field

Add a custom envelope field to a draft or in-process envelope.

Options

Field Definition Type Required

Accounts

Choose from available DocuSign accounts.

 Dropdown TRUE

Field Type

Choose from available field types.

 Dropdown TRUE

Input

Field Definition Type Required

Envelope ID

Unique ID of the envelope.

 Text TRUE

Name

Name of the custom field.

 Text TRUE

List items

List of possible values for the custom field; only appears when Field Type is List.

 List of Text FALSE

Show

Indicates whether to show the custom field.

 True/False FALSE

Required

Indicates whether the custom field is required.

 True/False FALSE

Value

Default value of the custom field.

 Text FALSE

Output

Field Definition Type

Status Code

Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:

  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

 Number

Field ID

Unique ID of the custom field.

 Text

Name

Name of the custom field.

 Text

Value

Value of the custom field.

 Text

List Items

List of possible values for the custom field; only appears when Field Type is List.

 List of Text