Chilkat Online Tools

autoit / DocuSign eSignature REST API / Updates envelope custom fields for an envelope.

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

; The following JSON is sent in the request body.

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

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("textCustomFields[0].fieldId","sample string 1")
$oJson.UpdateString("textCustomFields[0].name","sample string 2")
$oJson.UpdateString("textCustomFields[0].show","sample string 3")
$oJson.UpdateString("textCustomFields[0].required","sample string 4")
$oJson.UpdateString("textCustomFields[0].value","sample string 5")
$oJson.UpdateString("textCustomFields[0].configurationType","sample string 6")
$oJson.UpdateString("listCustomFields[0].listItems[0]","sample string 1")
$oJson.UpdateString("listCustomFields[0].fieldId","sample string 1")
$oJson.UpdateString("listCustomFields[0].name","sample string 2")
$oJson.UpdateString("listCustomFields[0].show","sample string 3")
$oJson.UpdateString("listCustomFields[0].required","sample string 4")
$oJson.UpdateString("listCustomFields[0].value","sample string 5")
$oJson.UpdateString("listCustomFields[0].configurationType","sample string 6")

; Adds the "Authorization: Bearer {{accessToken}}" header.
$oHttp.AuthToken = "{{accessToken}}"
$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/custom_fields","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "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"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/custom_fields

Postman Collection Item JSON

{
  "name": "Updates envelope custom fields for an envelope.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"textCustomFields\": [\n    {\n      \"fieldId\": \"sample string 1\",\n      \"name\": \"sample string 2\",\n      \"show\": \"sample string 3\",\n      \"required\": \"sample string 4\",\n      \"value\": \"sample string 5\",\n      \"configurationType\": \"sample string 6\"\n    }\n  ],\n  \"listCustomFields\": [\n    {\n      \"listItems\": [\n        \"sample string 1\"\n      ],\n      \"fieldId\": \"sample string 1\",\n      \"name\": \"sample string 2\",\n      \"show\": \"sample string 3\",\n      \"required\": \"sample string 4\",\n      \"value\": \"sample string 5\",\n      \"configurationType\": \"sample string 6\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/custom_fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "custom_fields"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    },
    "description": "Updates the envelope custom fields for draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name."
  },
  "response": [
  ]
}