Chilkat Online Tools

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

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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 = Chilkat::CkJsonObject.new()
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")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a 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)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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