Chilkat Online Tools

Python / DocuSign eSignature REST API / 19. Create a Template with Role Only

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.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.

# {
#   "documents": [
#     {
#       "name": "agreement",
#       "documentBase64": "{{documentBase64}}",
#       "documentId": 123,
#       "fileExtension": "pdf"
#     }
#   ],
#   "emailBlurb": "Email message",
#   "emailSubject": "email subject",
#   "recipients": {
#     "signers": [
#       {
#         "recipientId": "1",
#         "roleName": "seller",
#         "tabs": {
#           "signHereTabs": [
#             {
#               "documentId": 123,
#               "pageNumber": 1,
#               "xPosition": "4",
#               "yPosition": "4"
#             }
#           ]
#         }
#       }
#     ]
#   }
# }

json = chilkat2.JsonObject()
json.UpdateString("documents[0].name","agreement")
json.UpdateString("documents[0].documentBase64","{{documentBase64}}")
json.UpdateInt("documents[0].documentId",123)
json.UpdateString("documents[0].fileExtension","pdf")
json.UpdateString("emailBlurb","Email message")
json.UpdateString("emailSubject","email subject")
json.UpdateString("recipients.signers[0].recipientId","1")
json.UpdateString("recipients.signers[0].roleName","seller")
json.UpdateInt("recipients.signers[0].tabs.signHereTabs[0].documentId",123)
json.UpdateInt("recipients.signers[0].tabs.signHereTabs[0].pageNumber",1)
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].xPosition","4")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].yPosition","4")

# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/templates","application/json",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
  "documents": [
    {
      "name": "agreement",
      "documentBase64": {{document}},
      "documentId": {{documentId}},
      "fileExtension": "pdf"
    }
  ],
  "emailBlurb": "Email message",
  "emailSubject": "email subject",
  "recipients": {
    "signers": [
      {
        "recipientId": "1",
        "roleName": "seller",
        "tabs": {
          "signHereTabs": [
            {
              "documentId": {{documentId}},
              "pageNumber": 1,
              "xPosition": "4",
              "yPosition": "4"
            }
          ]
        }
      }
    ]
  }
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/templates

Postman Collection Item JSON

{
  "name": "19. Create a Template with Role Only",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "var templateId = jsonData.templateId;",
          "postman.setEnvironmentVariable(\"templateId\", templateId); "
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{accessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"documents\": [\n    {\n      \"name\": \"agreement\",\n      \"documentBase64\": {{document}},\n      \"documentId\": {{documentId}},\n      \"fileExtension\": \"pdf\"\n    }\n  ],\n  \"emailBlurb\": \"Email message\",\n  \"emailSubject\": \"email subject\",\n  \"recipients\": {\n    \"signers\": [\n      {\n        \"recipientId\": \"1\",\n        \"roleName\": \"seller\",\n        \"tabs\": {\n          \"signHereTabs\": [\n            {\n              \"documentId\": {{documentId}},\n              \"pageNumber\": 1,\n              \"xPosition\": \"4\",\n              \"yPosition\": \"4\"\n            }\n          ]\n        }\n      }\n    ]\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/templates",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "templates"
      ]
    },
    "description": "In order to make templates more board and be able to use them in `CompositeTemplates` we can create them by specifying the role only. This way, the recipients can be specified at envelope creation. This example shows how useful templates can be."
  },
  "response": [
  ]
}