Chilkat Online Tools

delphiDll / DocuSign eSignature REST API / Adds or replaces the bulk recipients list in a template.

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

// 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"
//         }
//       ]
//     }
//   ]
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'bulkRecipients[0].rowNumber','sample string 1');
CkJsonObject_UpdateString(json,'bulkRecipients[0].email','sample string 2');
CkJsonObject_UpdateString(json,'bulkRecipients[0].name','sample string 3');
CkJsonObject_UpdateString(json,'bulkRecipients[0].note','sample string 4');
CkJsonObject_UpdateString(json,'bulkRecipients[0].accessCode','sample string 5');
CkJsonObject_UpdateString(json,'bulkRecipients[0].identification','sample string 6');
CkJsonObject_UpdateString(json,'bulkRecipients[0].phoneNumber','sample string 7');
CkJsonObject_UpdateString(json,'bulkRecipients[0].tabLabels[0].name','sample string 1');
CkJsonObject_UpdateString(json,'bulkRecipients[0].tabLabels[0].value','sample string 2');
CkJsonObject_UpdateString(json,'bulkRecipients[0].recipientSignatureProviderInfo[0].name','sample string 1');
CkJsonObject_UpdateString(json,'bulkRecipients[0].recipientSignatureProviderInfo[0].value','sample string 2');

// Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_putAuthToken(http,'{{accessToken}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients/{{recipientId}}/bulk_recipients',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

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": [
  ]
}