Chilkat Online Tools

Ruby / DocuSign Click API / Deletes the clickwrap and all its version specified by clickwrapId. Active clickwrap will not get deleted

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

# The following JSON is sent in the request body.

# {}

json = Chilkat::CkJsonObject.new()

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("DELETE","https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}?versions={{versions}}",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X DELETE
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{}'
https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}?versions={{versions}}

Postman Collection Item JSON

{
  "name": "Deletes the clickwrap and all its version specified by clickwrapId. Active clickwrap will not get deleted",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{}"
    },
    "url": {
      "raw": "https://{{hostenv}}/clickapi/v1/accounts/{{accountId}}/clickwraps/{{clickwrapId}}?versions={{versions}}",
      "protocol": "https",
      "host": [
        "{{hostenv}}"
      ],
      "path": [
        "clickapi",
        "v1",
        "accounts",
        "{{accountId}}",
        "clickwraps",
        "{{clickwrapId}}"
      ],
      "query": [
        {
          "key": "versions",
          "value": "{{versions}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "clickwrapId",
          "value": "{{clickwrapId}}"
        }
      ]
    }
  },
  "response": [
  ]
}