Chilkat Online Tools

Ruby / DocuSign REST API / Adds templates to an envelope.

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("documentTemplates[0].documentId","sample string 1")
json.UpdateString("documentTemplates[0].templateId","sample string 2")
json.UpdateString("documentTemplates[0].documentStartPage","sample string 3")
json.UpdateString("documentTemplates[0].documentEndPage","sample string 4")

# Adds the "Authorization: Bearer {{accessToken}}" header.
http.put_AuthToken("{{accessToken}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/templates?preserve_template_recipient={{preserve_template_recipient}}","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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}}/templates?preserve_template_recipient={{preserve_template_recipient}}

Postman Collection Item JSON

{
  "name": "Adds templates to 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}}/templates?preserve_template_recipient={{preserve_template_recipient}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "templates"
      ],
      "query": [
        {
          "key": "preserve_template_recipient",
          "value": "{{preserve_template_recipient}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Adds templates to the specified envelope."
  },
  "response": [
  ]
}