Retrieves the custom document field information from an existing template.

Request

HTTP request

GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

templateIdstring

The id of the template.

Responses

CodeDescriptionReference
200

Successful response.

TemplateCustomFields
400

Error encountered.

errorDetails

SDK Method

Templates::listCustomFields

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

listCustomField

This object represents a custom field that accepts a list.

configurationTypestring

If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

fieldIdstring

The id of the custom field.

listItems[array]

An array of strings that represent the items in a list.

namestring

The name of the list custom field.

requiredstring

When set to true, the signer is required to fill out the custom field.

showstring

When set to true, the custom field displays at the top of the certificate of completion.

valuestring

The value of the custom field.

Maximum Length: 100 characters.

textCustomField

This object represents a custom field that accepts text.

configurationTypestring

If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

fieldIdstring

The id of the custom field.

namestring

The name of the text custom field.

requiredstring

When set to true, the signer is required to fill out this tab.

showstring

When set to true, the custom field displays at the top of the certificate of completion.

valuestring

The button text that displays on the custom field in the document.

TemplateCustomFields

A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.

There are two types of 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.

listCustomFields[listCustomField]

An array of list custom fields.

textCustomFields[textCustomField]

An array of text custom fields.

Examples

Generic JSON Response

Response
{
  "textCustomFields": [
    {
      "fieldId": "sample string 1",
      "name": "sample string 2",
      "show": "sample string 3",
      "required": "sample string 4",
      "value": "sample string 5",
      "configurationType": "sample string 6",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ],
  "listCustomFields": [
    {
      "listItems": [
        "sample string 1"
      ],
      "fieldId": "sample string 1",
      "name": "sample string 2",
      "show": "sample string 3",
      "required": "sample string 4",
      "value": "sample string 5",
      "configurationType": "sample string 6",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      }
    }
  ]
}
Generic XML Response

Response
<customFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <listCustomFields>
    <listCustomField>
      <configurationType>sample string 6</configurationType>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <fieldId>sample string 1</fieldId>
      <name>sample string 2</name>
      <required>sample string 4</required>
      <show>sample string 3</show>
      <value>sample string 5</value>
      <listItems xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
      </listItems>
    </listCustomField>
  </listCustomFields>
  <textCustomFields>
    <textCustomField>
      <configurationType>sample string 6</configurationType>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <fieldId>sample string 1</fieldId>
      <name>sample string 2</name>
      <required>sample string 4</required>
      <show>sample string 3</show>
      <value>sample string 5</value>
    </textCustomField>
  </textCustomFields>
</customFields> 
}} />