SQL Server / DocuSign REST API / Adds or replaces the bulk recipients list in a template.
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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"
-- }
-- ]
-- }
-- ]
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].rowNumber', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].email', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].name', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].note', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].accessCode', 'sample string 5'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].identification', 'sample string 6'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].phoneNumber', 'sample string 7'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].tabLabels[0].name', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].tabLabels[0].value', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].recipientSignatureProviderInfo[0].name', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bulkRecipients[0].recipientSignatureProviderInfo[0].value', 'sample string 2'
-- Adds the "Authorization: Bearer {{accessToken}}" header.
EXEC sp_OASetProperty @http, 'AuthToken', '{{accessToken}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients/{{recipientId}}/bulk_recipients', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
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": [
]
}
