PowerBuilder / DocuSign REST API / 20. Send an Envelope Using CompositeTemplates
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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"
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("emailBlurb","Create an envelope with a templateId")
loo_Json.UpdateString("emailSubject","Template")
loo_Json.UpdateString("compositeTemplates[0].serverTemplates[0].sequence","1")
loo_Json.UpdateString("compositeTemplates[0].serverTemplates[0].templateId","{{templateId}}")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].email","{{user1_email}}")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].name","{{user1_name}}")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].recipientId","2")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].roleName","seller")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorString","test")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorUnits","pixels")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorXOffset","200")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorYOffset","10")
loo_Json.UpdateString("compositeTemplates[0].inlineTemplates[0].sequence","2")
loo_Json.UpdateString("status","sent")
// Adds the "Authorization: Bearer {{accessToken}}" header.
loo_Http.AuthToken = "{{accessToken}}"
loo_Resp = loo_Http.PostJson3("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp
destroy loo_Http
destroy loo_Json
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": [
]
}
