Chilkat Online Tools

C / DocuSign eSignature REST API / Adds templates to a document in an envelope.

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;

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

    http = CkHttp_Create();

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "documentTemplates": [
    //     {
    //       "documentId": "sample string 1",
    //       "templateId": "sample string 2",
    //       "documentStartPage": "sample string 3",
    //       "documentEndPage": "sample string 4"
    //     }
    //   ]
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"documentTemplates[0].documentId","sample string 1");
    CkJsonObject_UpdateString(json,"documentTemplates[0].templateId","sample string 2");
    CkJsonObject_UpdateString(json,"documentTemplates[0].documentStartPage","sample string 3");
    CkJsonObject_UpdateString(json,"documentTemplates[0].documentEndPage","sample string 4");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp_putAuthToken(http,"{{accessToken}}");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    resp = CkHttp_PostJson3(http,"https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/templates?preserve_template_recipient={{preserve_template_recipient}}","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);

    }

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "documentTemplates": [
    {
      "documentId": "sample string 1",
      "templateId": "sample string 2",
      "documentStartPage": "sample string 3",
      "documentEndPage": "sample string 4"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/templates?preserve_template_recipient={{preserve_template_recipient}}

Postman Collection Item JSON

{
  "name": "Adds templates to a document in an  envelope.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"documentTemplates\": [\n    {\n      \"documentId\": \"sample string 1\",\n      \"templateId\": \"sample string 2\",\n      \"documentStartPage\": \"sample string 3\",\n      \"documentEndPage\": \"sample string 4\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/templates?preserve_template_recipient={{preserve_template_recipient}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "documents",
        "{{documentId}}",
        "templates"
      ],
      "query": [
        {
          "key": "preserve_template_recipient",
          "value": "{{preserve_template_recipient}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "documentId",
          "value": "{{documentId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    },
    "description": "Adds templates to a document in the specified envelope."
  },
  "response": [
  ]
}