__INITIALS__
Deletes envelope custom fields in a template.
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields| Parameter Name | Value | Description |
|---|---|---|
| Path Parameters | ||
| accountId | string | The external account number (int) or account ID GUID. |
| templateId | string | The id of the template. |
| Code | Description | Reference |
|---|---|---|
| 200 | Successful response. | TemplateCustomFields |
| 400 | Error encountered. | errorDetails |
This object describes errors that occur. It is only valid for responses and ignored in requests. | ||
errorCode | string | The code associated with the error condition. |
message | string | A brief message describing the error condition. |
This object represents a custom field that accepts a list. | ||
configurationType | string | If merge fields are being used, specifies the type of the merge field. The only supported value is |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
fieldId | string | The id of the custom field. |
listItems | [array] | An array of strings that represent the items in a list. |
name | string | The name of the list custom field. |
required | string | When set to true, the signer is required to fill out the custom field. |
show | string | When set to true, the custom field displays at the top of the certificate of completion. |
value | string | The value of the custom field. Maximum Length: 100 characters. |
listCustomFields | [listCustomField] | An array of list custom fields. |
textCustomFields | [textCustomField] | An array of text custom fields. |
This object represents a custom field that accepts text. | ||
configurationType | string | If merge fields are being used, specifies the type of the merge field. The only supported value is |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
fieldId | string | The id of the custom field. |
name | string | The name of the text custom field. |
required | string | When set to true, the signer is required to fill out this tab. |
show | string | When set to true, the custom field displays at the top of the certificate of completion. |
value | string | The button text that displays on the custom field in the document. |
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:
| ||
listCustomFields | [listCustomField] | An array of list custom fields. |
textCustomFields | [textCustomField] | An array of text custom fields. |
{
"password": "sample string 1",
"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"
}
],
"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"
}
]
}
{
"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": ""
}
}
]
}
<templateCustomFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
<listCustomFields>
<listCustomField>
<configurationType>sample string 6</configurationType>
<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>
<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>
<password>sample string 1</password>
</templateCustomFields> <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>