Lua

DocuSign Send a Draft Envelope

See more DocuSign Examples

Demonstrates how to send a DocuSign draft envelope. 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)

-- PUT https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID> HTTP/1.1
-- Accept: application/json
-- Cache-Control: no-cache
-- Authorization: Bearer eyJ0eX...
-- Content-Length: ...
-- Content-Type: application/json
--
-- {
--   "status": "sent"
-- }

local json = chilkat.JsonObject.new()
json:update_string("status", "sent")

local sbJson = chilkat.StringBuilder.new()
json.emit_compact = false
json:emit_sb(sbJson)

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")
-- Use the envelope ID returned by DocuSign when creating the draft envelope).
http:set_url_var("envelopeId", "cee4191c-f94e-4089-9d7c-8033685cbc1a")

local url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}"

local resp = chilkat.HttpResponse.new()
success = http:http_sb("PUT", url, sbJson, "utf-8", "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)

-- If the envelope you're trying to send is not yet completed, you'll get an error such as this:
-- {
--   "errorCode": "ENVELOPE_IS_INCOMPLETE",
--   "message": "The Envelope is not Complete. A Complete Envelope Requires Documents, Recipients, Tabs, and a Subject Line."
-- }

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