Android / DocuSign eSignature REST API / Adds or replaces the bulk recipients list in a template.
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.
// {
// "bulkRecipients": [
// {
// "rowNumber": "sample string 1",
// "email": "sample string 2",
// "name": "sample string 3",
// "note": "sample string 4",
// "accessCode": "sample string 5",
// "identification": "sample string 6",
// "phoneNumber": "sample string 7",
// "tabLabels": [
// {
// "name": "sample string 1",
// "value": "sample string 2"
// }
// ],
// "recipientSignatureProviderInfo": [
// {
// "name": "sample string 1",
// "value": "sample string 2"
// }
// ]
// }
// ]
// }
CkJsonObject json = new CkJsonObject();
json.UpdateString("bulkRecipients[0].rowNumber","sample string 1");
json.UpdateString("bulkRecipients[0].email","sample string 2");
json.UpdateString("bulkRecipients[0].name","sample string 3");
json.UpdateString("bulkRecipients[0].note","sample string 4");
json.UpdateString("bulkRecipients[0].accessCode","sample string 5");
json.UpdateString("bulkRecipients[0].identification","sample string 6");
json.UpdateString("bulkRecipients[0].phoneNumber","sample string 7");
json.UpdateString("bulkRecipients[0].tabLabels[0].name","sample string 1");
json.UpdateString("bulkRecipients[0].tabLabels[0].value","sample string 2");
json.UpdateString("bulkRecipients[0].recipientSignatureProviderInfo[0].name","sample string 1");
json.UpdateString("bulkRecipients[0].recipientSignatureProviderInfo[0].value","sample string 2");
// 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("PUT","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients/{{recipientId}}/bulk_recipients",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 PUT
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"bulkRecipients": [
{
"rowNumber": "sample string 1",
"email": "sample string 2",
"name": "sample string 3",
"note": "sample string 4",
"accessCode": "sample string 5",
"identification": "sample string 6",
"phoneNumber": "sample string 7",
"tabLabels": [
{
"name": "sample string 1",
"value": "sample string 2"
}
],
"recipientSignatureProviderInfo": [
{
"name": "sample string 1",
"value": "sample string 2"
}
]
}
]
}'
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients/{{recipientId}}/bulk_recipients
Postman Collection Item JSON
{
"name": "Adds or replaces the bulk recipients list in a template.",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"bulkRecipients\": [\n {\n \"rowNumber\": \"sample string 1\",\n \"email\": \"sample string 2\",\n \"name\": \"sample string 3\",\n \"note\": \"sample string 4\",\n \"accessCode\": \"sample string 5\",\n \"identification\": \"sample string 6\",\n \"phoneNumber\": \"sample string 7\",\n \"tabLabels\": [\n {\n \"name\": \"sample string 1\",\n \"value\": \"sample string 2\"\n }\n ],\n \"recipientSignatureProviderInfo\": [\n {\n \"name\": \"sample string 1\",\n \"value\": \"sample string 2\"\n }\n ]\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients/{{recipientId}}/bulk_recipients",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"templates",
"{{templateId}}",
"recipients",
"{{recipientId}}",
"bulk_recipients"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
},
{
"key": "recipientId",
"value": "{{recipientId}}",
"type": "string"
},
{
"key": "templateId",
"value": "{{templateId}}",
"type": "string"
}
]
},
"description": "Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).\n\nThe REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file."
},
"response": [
]
}