{"api":"esign_rest","category":"reference"}

AccountCustomFields Resource

Custom fields enable you to record custom information about envelopes that you can then use for sorting, organizing, searching, and other downstream processes.

For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault all of their documents from the web app by setting an account custom field with a name like eVault with eOriginal to true.

You can also use account custom fields to set the following information:

  • Tracking ID
  • Department
  • Use case
  • Other envelope metadata

Envelope Custom Field Visibility

When you create an envelope custom field for your account, you have the following options:

  • Make it a required field for senders at the time of sending
  • Display it as an optional field at the time of sending
  • Set a specific value for the field behind the scenes (NOT SURE IF THIS IS RIGHT; MIGHT JUST BE AN UNUSED DRAFT FIELD)

Envelope recipients do not see the envelope custom fields.

Types of Envelope Custom Fields

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.
MethodDescription
list
GET /v2.1/accounts/{accountId}/custom_fields

Gets a list of custom fields.

create
POST /v2.1/accounts/{accountId}/custom_fields

Creates an account custom field.

update
PUT /v2.1/accounts/{accountId}/custom_fields/{customFieldId}

Updates an account custom field.

delete
DELETE /v2.1/accounts/{accountId}/custom_fields/{customFieldId}

Deletes an account custom field.

}} />