Lua Requires Chilkat v11.0.0+

DocuSign Create Empty Envelope Draft

See more DocuSign Examples

Creates an empty envelope draft. The JSON response includes the envelope ID which can be used to add documents, recipients, etc. until the envelope is ready to send. Lua

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

-- Load a previously obtained OAuth2 access token.
local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/docusign.json")
if not success then
    print(jsonToken.last_error_text)
    return
end

-- Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.auth_token = jsonToken:string_of("access_token")

-- Send the following request.
-- Make sure to use your own account ID (obtained from Get Docusign User Account Information)

-- POST https://demo.docusign.net/restapi/v2.1/accounts/7f3f65ed-5e87-418d-94c1-92499ddc8252/envelopes HTTP/1.1
-- Accept: application/json
-- Cache-Control: no-cache
-- Authorization: Bearer eyJ0eX...
-- Content-Length: ...
-- Content-Type: application/json
--
-- {
--   "emailSubject": "Sign for Project XYZ Approval"
-- }

local json = chilkat.JsonObject.new()
json:update_string("emailSubject", "Sign for Project XYZ Approval")

http:set_request_header("Cache-Control", "no-cache")
http:set_request_header("Accept", "application/json")

-- Use your own account ID here.
http:set_url_var("accountId", "7f3f65ed-5e87-418d-94c1-92499ddc8252")

local resp = chilkat.HttpResponse.new()
success = http:http_json("POST", "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes", json, "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

local jResp = chilkat.JsonObject.new()
jResp:load(resp.body_str)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

-- If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(resp.header)
    print("Failed.")
    return
end

-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)

-- {
--   "envelopeId": "4943126a-a6e0-40ca-8707-50f22bf3888c",
--   "uri": "/envelopes/4943126a-a6e0-40ca-8707-50f22bf3888c",
--   "statusDateTime": "2021-01-23T20:21:42.1400000Z",
--   "status": "created"
-- }

-- Sample code for parsing the JSON response...
-- Use the following online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON

local envelopeId = jResp:string_of("envelopeId")
local uri = jResp:string_of("uri")
local statusDateTime = jResp:string_of("statusDateTime")
local status = jResp:string_of("status")