Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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"
    ;             }
    ;           ]
    ;         }
    ;       }
    ;     ]
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    ; Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp::setCkAuthToken(http, "{{accessToken}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/{{apiVersion}}/accounts/{{accountId}}/templates","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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