Chilkat Online Tools

TCL / DocuSign REST API / Deletes the signature for one or more captive recipient records.

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

# The following JSON is sent in the request body.

# {
#   "captiveRecipients": [
#     {
#       "email": "sample string 1",
#       "userName": "sample string 2",
#       "clientUserId": "sample string 3"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "captiveRecipients[0].email" "sample string 1"
CkJsonObject_UpdateString $json "captiveRecipients[0].userName" "sample string 2"
CkJsonObject_UpdateString $json "captiveRecipients[0].clientUserId" "sample string 3"

# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "DELETE" "https://domain.com/v2.1/accounts/{{accountId}}/captive_recipients/{{recipientPart}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X DELETE
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "captiveRecipients": [
    {
      "email": "sample string 1",
      "userName": "sample string 2",
      "clientUserId": "sample string 3"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/captive_recipients/{{recipientPart}}

Postman Collection Item JSON

{
  "name": "Deletes the signature for one or more captive recipient records.",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"captiveRecipients\": [\n    {\n      \"email\": \"sample string 1\",\n      \"userName\": \"sample string 2\",\n      \"clientUserId\": \"sample string 3\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/captive_recipients/{{recipientPart}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "captive_recipients",
        "{{recipientPart}}"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "recipientPart",
          "value": "{{recipientPart}}"
        }
      ]
    },
    "description": "Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used."
  },
  "response": [
  ]
}