Chilkat Online Tools

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

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.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"
#     }
#   ]
# }

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

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

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("DELETE","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/custom_fields",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

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}}"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}"
        }
      ]
    },
    "description": "Deletes envelope custom fields in a template."
  },
  "response": [
  ]
}