Deletes envelope custom fields in a template.

Request

HTTP request

DELETE /v2/accounts/{accountId}/templates/{templateId}/custom_fields

Parameters

Parameter name Value Description
Path parameters
accountId string

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

templateId string

The ID of the template being accessed.

Request Body

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Templates::deleteCustomFields

Definitions Expand All | Collapse All

TemplateCustomFields

Template custom fields

listCustomFields
[listCustomField]

An array of list custom fields.

textCustomFields
[textCustomField]

An array of text custom fields.

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

listCustomField

configurationType string

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

errorDetails errorDetails
fieldId string

An ID used to specify a custom field.

listItems
[string]
name string

The name of the custom field.

required string

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

show string

A boolean indicating if the value should be displayed.

value string

The value of the custom field.

Maximum Length: 100 characters.

templateCustomFields

listCustomFields
[listCustomField]

An array of list custom fields.

textCustomFields
[textCustomField]

An array of text custom fields.

textCustomField

configurationType string

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

errorDetails errorDetails
fieldId string

An ID used to specify a custom field.

name string

The name of the custom field.

required string

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

show string

A boolean indicating if the value should be displayed.

value string

The value of the custom field.

Examples

Generic JSON Request/Response

Request

{
"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"
}
]
}

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 Request/Response

Request

<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>

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>