Chilkat Online Tools

C++ / DocuSign Click API / 20. Send an Envelope Using CompositeTemplates

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    // 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}}",
    //                 "name": "{{user1_name}}",
    //                 "recipientId": "2",
    //                 "roleName": "seller",
    //                 "tabs": {
    //                   "signHereTabs": [
    //                     {
    //                       "anchorString": "test",
    //                       "anchorUnits": "pixels",
    //                       "anchorXOffset": "200",
    //                       "anchorYOffset": "10"
    //                     }
    //                   ]
    //                 }
    //               }
    //             ]
    //           },
    //           "sequence": "2"
    //         }
    //       ]
    //     }
    //   ],
    //   "status": "sent"
    // }

    CkJsonObject json;
    json.UpdateString("emailBlurb","Create an envelope with a templateId");
    json.UpdateString("emailSubject","Template");
    json.UpdateString("compositeTemplates[0].serverTemplates[0].sequence","1");
    json.UpdateString("compositeTemplates[0].serverTemplates[0].templateId","{{templateId}}");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].email","{{user1}}");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].name","{{user1_name}}");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].recipientId","2");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].roleName","seller");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorString","test");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorUnits","pixels");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorXOffset","200");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorYOffset","10");
    json.UpdateString("compositeTemplates[0].inlineTemplates[0].sequence","2");
    json.UpdateString("status","sent");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    http.put_AuthToken("{{accessToken}}");

    CkHttpResponse *resp = http.PostJson3("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    std::cout << resp->get_StatusCode() << "\r\n";
    std::cout << resp->bodyStr() << "\r\n";
    delete resp;
    }

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}}",
                                "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}}\",\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": [
  ]
}