Chilkat Online Tools

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

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttpW http;
    bool 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"
    //         }
    //       ]
    //     }
    //   ]
    // }

    CkJsonObjectW json;
    json.UpdateString(L"bulkRecipients[0].rowNumber",L"sample string 1");
    json.UpdateString(L"bulkRecipients[0].email",L"sample string 2");
    json.UpdateString(L"bulkRecipients[0].name",L"sample string 3");
    json.UpdateString(L"bulkRecipients[0].note",L"sample string 4");
    json.UpdateString(L"bulkRecipients[0].accessCode",L"sample string 5");
    json.UpdateString(L"bulkRecipients[0].identification",L"sample string 6");
    json.UpdateString(L"bulkRecipients[0].phoneNumber",L"sample string 7");
    json.UpdateString(L"bulkRecipients[0].tabLabels[0].name",L"sample string 1");
    json.UpdateString(L"bulkRecipients[0].tabLabels[0].value",L"sample string 2");
    json.UpdateString(L"bulkRecipients[0].recipientSignatureProviderInfo[0].name",L"sample string 1");
    json.UpdateString(L"bulkRecipients[0].recipientSignatureProviderInfo[0].value",L"sample string 2");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    http.put_AuthToken(L"{{accessToken}}");
    http.SetRequestHeader(L"Accept",L"application/json");

    CkStringBuilderW sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponseW *resp = http.PTextSb(L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients/{{recipientId}}/bulk_recipients",sbRequestBody,L"utf-8",L"application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    wprintf(L"%d\n",resp->get_StatusCode());
    wprintf(L"%s\n",resp->bodyStr());
    delete resp;
    }

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}}"
        },
        {
          "key": "recipientId",
          "value": "{{recipientId}}"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}"
        }
      ]
    },
    "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": [
  ]
}