Skip to navigation

TemplateCustomFields Resource

View as Markdown

The TemplateCustomFields resource provides methods that allow you manage custom fields in an template.

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

There are two types of template custom fields, text and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.

Methods supported

MethodDescription
createPOST /restapi/v2/accounts/{accountId}/templates/{templateId}/custom_fields
Creates custom document fields in an existing template document.
deleteDEL /restapi/v2/accounts/{accountId}/templates/{templateId}/custom_fields
Deletes envelope custom fields in a template.
listGET /restapi/v2/accounts/{accountId}/templates/{templateId}/custom_fields
Gets the custom document fields from a template.
updatePUT /restapi/v2/accounts/{accountId}/templates/{templateId}/custom_fields
Updates envelope custom fields in a template.

TemplateCustomFields properties

PropertyTypeDescription
listCustomFieldsarrayAn array of list custom fields.
textCustomFieldsarrayAn array of text custom fields.