Template Document Fields

Updates existing custom document fields in an existing template document

PUT
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields

Updates existing custom document fields in an existing template document.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

documentId*string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).

Tab objects have a documentId property that specifies the document on which to place the tab.

templateId*string

The ID of the template.

Request Body

application/json

documentFields?array<>

The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements:

  • name: A string that can be a maximum of 50 characters.
  • value: A string that can be a maximum of 200 characters.

If you are using XML, the name/value pair is contained in a nameValue element.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/templates/string/documents/string/fields" \  -H "Content-Type: application/json" \  -d '{}'
{  "documentFields": [    {      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "name": "string",      "originalValue": "string",      "value": "string"    }  ]}