SQL Server / DocuSign REST API / 20. Send an Envelope Using CompositeTemplates
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.
-- {
-- "emailBlurb": "Create an envelope with a templateId",
-- "emailSubject": "Template",
-- "compositeTemplates": [
-- {
-- "serverTemplates": [
-- {
-- "sequence": "1",
-- "templateId": "{{templateId}}"
-- }
-- ],
-- "inlineTemplates": [
-- {
-- "recipients": {
-- "signers": [
-- {
-- "email": "{{user1_email}}",
-- "name": "{{user1_name}}",
-- "recipientId": "2",
-- "roleName": "seller",
-- "tabs": {
-- "signHereTabs": [
-- {
-- "anchorString": "test",
-- "anchorUnits": "pixels",
-- "anchorXOffset": "200",
-- "anchorYOffset": "10"
-- }
-- ]
-- }
-- }
-- ]
-- },
-- "sequence": "2"
-- }
-- ]
-- }
-- ],
-- "status": "sent"
-- }
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, 'emailBlurb', 'Create an envelope with a templateId'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'emailSubject', 'Template'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].serverTemplates[0].sequence', '1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].serverTemplates[0].templateId', '{{templateId}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].recipients.signers[0].email', '{{user1_email}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].recipients.signers[0].name', '{{user1_name}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].recipients.signers[0].recipientId', '2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].recipients.signers[0].roleName', 'seller'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorString', 'test'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorUnits', 'pixels'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorXOffset', '200'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorYOffset', '10'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compositeTemplates[0].inlineTemplates[0].sequence', '2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'status', 'sent'
-- Adds the "Authorization: Bearer {{accessToken}}" header.
EXEC sp_OASetProperty @http, 'AuthToken', '{{accessToken}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes', 'application/json', @json
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
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
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer {{accessToken}}"
-d '{
"emailBlurb": "Create an envelope with a templateId",
"emailSubject": "Template",
"compositeTemplates": [
{
"serverTemplates": [
{
"sequence": "1",
"templateId": "{{templateId}}"
}
],
"inlineTemplates": [
{
"recipients": {
"signers": [
{
"email": "{{user1_email}}",
"name": "{{user1_name}}",
"recipientId": "2",
"roleName": "seller",
"tabs": {
"signHereTabs": [
{
"anchorString": "test",
"anchorUnits": "pixels",
"anchorXOffset": "200",
"anchorYOffset": "10"
}
]
}
}
]
},
"sequence": "2"
}
]
}
],
"status": "sent"
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes
Postman Collection Item JSON
{
"name": "20. Send an Envelope Using CompositeTemplates",
"request": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailBlurb\": \"Create an envelope with a templateId\",\n \"emailSubject\": \"Template\",\n \"compositeTemplates\": [\n {\n \"serverTemplates\": [\n {\n \"sequence\": \"1\",\n \"templateId\": \"{{templateId}}\"\n }\n ],\n \"inlineTemplates\": [\n {\n \"recipients\": {\n \"signers\": [\n {\n \"email\": \"{{user1_email}}\",\n \"name\": \"{{user1_name}}\",\n \"recipientId\": \"2\",\n \"roleName\": \"seller\",\n \"tabs\": {\n \"signHereTabs\": [\n {\n \"anchorString\": \"test\",\n \"anchorUnits\": \"pixels\",\n \"anchorXOffset\": \"200\",\n \"anchorYOffset\": \"10\"\n }\n ]\n }\n }\n ]\n },\n \"sequence\": \"2\"\n }\n ]\n }\n ],\n \"status\": \"sent\"\n}"
},
"url": {
"raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes",
"host": [
"{{baseUrl}}"
],
"path": [
"{{apiVersion}}",
"accounts",
"{{accountId}}",
"envelopes"
]
},
"description": "In this example, we will use the template we created in previous step and we will use `CompositeTemplates` to add a signer and a tab to it using `inlineTemplates`. You can see how one can create a template and keep reusing it this way."
},
"response": [
]
}
