PureBasic / DocuSign REST API / Deletes the signature for one or more captive recipient records.
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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"
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"captiveRecipients[0].email","sample string 1")
CkJsonObject::ckUpdateString(json,"captiveRecipients[0].userName","sample string 2")
CkJsonObject::ckUpdateString(json,"captiveRecipients[0].clientUserId","sample string 3")
; Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp::setCkAuthToken(http, "{{accessToken}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"DELETE","https://domain.com/v2.1/accounts/{{accountId}}/captive_recipients/{{recipientPart}}",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
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": [
]
}