Chilkat Online Tools

VB6 / DocuSign Click API / 15. Create an Account Template

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

' 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",
'         "email": "{{email}}",
'         "name": "{{name}}",
'         "tabs": {
'           "signHereTabs": [
'             {
'               "documentId": "123",
'               "pageNumber": 1,
'               "xPosition": "4",
'               "yPosition": "4"
'             }
'           ]
'         }
'       }
'     ]
'   }
' }

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

' Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"

Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/templates","application/json",json)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print resp.StatusCode
Debug.Print resp.BodyStr

Curl Command

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

Postman Collection Item JSON

{
  "name": "15. Create an Account Template",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"templateId\", jsonData.templateId);"
        ]
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "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        \"email\":{{user1}},\n        \"name\": {{user1_name}},\n        \"tabs\": {\n          \"signHereTabs\": [\n            {\n              \"documentId\": \"123\",\n              \"pageNumber\": 1,\n              \"xPosition\": \"4\",\n              \"yPosition\": \"4\"\n            }\n          ]\n        }\n      }\n    ]\n  }\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/templates",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "templates"
      ]
    },
    "description": "In this example, we will create a template with document, tabs and its recipients specified. This is a great future if we know we will be sending the same envelope multiple times."
  },
  "response": [
  ]
}