Chilkat Online Tools

Foxpro / DocuSign eSignature 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": [
*               {
*                 "recipientId": "2",
*                 "roleName": "seller",
*                 "email": "{{email}}",
*                 "name": "{{name}}"
*               }
*             ]
*           },
*           "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].recipientId","2")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].roleName","seller")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].email","{{email}}")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].name","{{name}}")
loJson.UpdateString("compositeTemplates[0].inlineTemplates[0].sequence","2")
loJson.UpdateString("status","sent")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

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 <access_token>"
	-d '{
    "emailBlurb": "Create an envelope with a templateId",
    "emailSubject": "Template",
    "compositeTemplates": [
        {
            "serverTemplates": [
                {
                    "sequence": "1",
                    "templateId": "{{templateId}}"
                }
            ],
            "inlineTemplates": [
                {
                    "recipients": {
                        "signers": [
                            {
                                "recipientId": "2",
                                "roleName": "seller",
                                "email":{{user1}},
                                "name": {{user1_name}}
                            }
                        ]
                    },
                    "sequence": "2"
                }
            ]
        }
    ],
    "status": "sent"
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes

Postman Collection Item JSON

{
  "name": "20. Send an Envelope Using CompositeTemplates",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{accessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "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                                \"recipientId\": \"2\",\n                                \"roleName\": \"seller\",\n                                \"email\":{{user1}},\n                                \"name\": {{user1_name}}\n                            }\n                        ]\n                    },\n                    \"sequence\": \"2\"\n                }\n            ]\n        }\n    ],\n    \"status\": \"sent\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "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": [
  ]
}