PureBasic / DocuSign REST API / Adds or replaces the bulk recipients list in a template.
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].rowNumber","sample string 1")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].email","sample string 2")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].name","sample string 3")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].note","sample string 4")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].accessCode","sample string 5")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].identification","sample string 6")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].phoneNumber","sample string 7")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].tabLabels[0].name","sample string 1")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].tabLabels[0].value","sample string 2")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].recipientSignatureProviderInfo[0].name","sample string 1")
CkJsonObject::ckUpdateString(json,"bulkRecipients[0].recipientSignatureProviderInfo[0].value","sample string 2")
; Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp::setCkAuthToken(http, "{{accessToken}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients/{{recipientId}}/bulk_recipients",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
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": [
]
}