Chilkat Online Tools

Foxpro / DocuSign eSignature REST API / Deletes envelope custom fields in a template.

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

* The following JSON is sent in the request body.

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("password","sample string 1")
loJson.UpdateString("textCustomFields[0].fieldId","sample string 1")
loJson.UpdateString("textCustomFields[0].name","sample string 2")
loJson.UpdateString("textCustomFields[0].show","sample string 3")
loJson.UpdateString("textCustomFields[0].required","sample string 4")
loJson.UpdateString("textCustomFields[0].value","sample string 5")
loJson.UpdateString("textCustomFields[0].configurationType","sample string 6")
loJson.UpdateString("listCustomFields[0].listItems[0]","sample string 1")
loJson.UpdateString("listCustomFields[0].fieldId","sample string 1")
loJson.UpdateString("listCustomFields[0].name","sample string 2")
loJson.UpdateString("listCustomFields[0].show","sample string 3")
loJson.UpdateString("listCustomFields[0].required","sample string 4")
loJson.UpdateString("listCustomFields[0].value","sample string 5")
loJson.UpdateString("listCustomFields[0].configurationType","sample string 6")

* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("DELETE","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/custom_fields",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

Curl Command

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

Postman Collection Item JSON

{
  "name": "Deletes envelope custom fields in a template.",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"password\": \"sample string 1\",\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}}/templates/{{templateId}}/custom_fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "custom_fields"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}",
          "type": "string"
        }
      ]
    },
    "description": "Deletes envelope custom fields in a template."
  },
  "response": [
  ]
}