Chilkat Online Tools

autoit / DocuSign eSignature REST API / 1. Create Envelope

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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": [
;     {
;       "documentBase64": "{{documentBase64}}",
;       "documentId": 123,
;       "fileExtension": "pdf",
;       "name": "document"
;     }
;   ],
;   "emailSubject": "Simple Signing Example",
;   "recipients": {
;     "signers": [
;       {
;         "email": "{{email}}",
;         "name": "{{name}}",
;         "recipientId": "{{recipientId}}"
;       }
;     ]
;   },
;   "status": "sent"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("documents[0].documentBase64","{{documentBase64}}")
$oJson.UpdateInt("documents[0].documentId",123)
$oJson.UpdateString("documents[0].fileExtension","pdf")
$oJson.UpdateString("documents[0].name","document")
$oJson.UpdateString("emailSubject","Simple Signing Example")
$oJson.UpdateString("recipients.signers[0].email","{{email}}")
$oJson.UpdateString("recipients.signers[0].name","{{name}}")
$oJson.UpdateString("recipients.signers[0].recipientId","{{recipientId}}")
$oJson.UpdateString("status","sent")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"

Local $oResp = $oHttp.PostJson3("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "documents": [
    {
      "documentBase64": {{document}},
      "documentId": {{documentId}},
      "fileExtension": "pdf",
      "name": "document"
    }
  ],
  "emailSubject": "Simple Signing Example",
  "recipients": {
    "signers": [
      {
        "email": {{user1}},
        "name": {{user1_name}},
        "recipientId": "{{recipientId}}"
      }
    ]
  },
  "status": "sent"
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes

Postman Collection Item JSON

{
  "name": "1. Create Envelope",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "var envelopeId = jsonData.envelopeId;",
          "postman.setEnvironmentVariable(\"envelopeId\", envelopeId); ",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{accessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"documents\": [\n    {\n      \"documentBase64\": {{document}},\n      \"documentId\": {{documentId}},\n      \"fileExtension\": \"pdf\",\n      \"name\": \"document\"\n    }\n  ],\n  \"emailSubject\": \"Simple Signing Example\",\n  \"recipients\": {\n    \"signers\": [\n      {\n        \"email\": {{user1}},\n        \"name\": {{user1_name}},\n        \"recipientId\": \"{{recipientId}}\"\n      }\n    ]\n  },\n  \"status\": \"sent\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes"
      ]
    },
    "description": "This example is a very basic example of creating an evenlope with a document and a single signer. This evenlope does not specify a tab."
  },
  "response": [
  ]
}