Android / DocuSign eSignature REST API / Deletes the signature for one or more captive recipient records.
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
// 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"
// }
// ]
// }
CkJsonObject json = new CkJsonObject();
json.UpdateString("captiveRecipients[0].email","sample string 1");
json.UpdateString("captiveRecipients[0].userName","sample string 2");
json.UpdateString("captiveRecipients[0].clientUserId","sample string 3");
// Adds the "Authorization: Bearer {{accessToken}}" header.
http.put_AuthToken("{{accessToken}}");
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbRequestBody = new CkStringBuilder();
json.EmitSb(sbRequestBody);
CkHttpResponse resp = http.PTextSb("DELETE","https://domain.com/v2.1/accounts/{{accountId}}/captive_recipients/{{recipientPart}}",sbRequestBody,"utf-8","application/json",false,false);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
Log.i(TAG, String.valueOf(resp.get_StatusCode()));
Log.i(TAG, resp.bodyStr());
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
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}}",
"type": "string"
},
{
"key": "recipientPart",
"value": "{{recipientPart}}",
"type": "string"
}
]
},
"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": [
]
}