Foxpro / DocuSign REST API / 20. Send an Envelope Using CompositeTemplates
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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"
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("emailBlurb","Create an envelope with a templateId")
loJson.UpdateString("emailSubject","Template")
loJson.UpdateString("compositeTemplates[0].serverTemplates[0].sequence","1")
loJson.UpdateString("compositeTemplates[0].serverTemplates[0].templateId","{{templateId}}")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].email","{{user1_email}}")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].name","{{user1_name}}")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].recipientId","2")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].roleName","seller")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorString","test")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorUnits","pixels")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorXOffset","200")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorYOffset","10")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].sequence","2")
loJson.UpdateString("status","sent")
* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loResp = loHttp.PostJson3("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp
RELEASE loHttp
RELEASE loJson
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": [
]
}
