Lua
Lua
DocuSign Add Recipients to a Draft Envelope
See more DocuSign Examples
Demonstrates how to add one or more recipients to a DocuSign draft envelope.Chilkat Lua Downloads
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/<account ID>/envelopes/<envelope ID>/recipients HTTP/1.1
-- Accept: application/json
-- Cache-Control: no-cache
-- Authorization: Bearer eyJ0eX...
-- Content-Length: ...
-- Content-Type: application/json
--
-- {
-- "carbonCopies": [
-- {
-- "email": "support@chilkatsoft.com",
-- "name": "Chilkat Support",
-- "recipientId": "101",
-- "tabs": {}
-- }
-- ],
-- "signers": [
-- {
-- "email": "admin@chilkatsoft.com",
-- "name": "Chilkat Admin",
-- "recipientId": "1",
-- "tabs": {
-- "signHereTabs": [{
-- "anchorString": "Please Sign Here",
-- "anchorXOffset": "1",
-- "anchorYOffset": "0",
-- "anchorIgnoreIfNotPresent": "false",
-- "anchorUnits": "inches"
-- }]
-- }
-- },
-- {
-- "email": "matt@chilkat.io",
-- "name": "Matt",
-- "recipientId": "2",
-- "tabs": {
-- "signHereTabs": [{
-- "anchorString": "Please Also Sign Here",
-- "anchorXOffset": "1",
-- "anchorYOffset": "0",
-- "anchorIgnoreIfNotPresent": "false",
-- "anchorUnits": "inches"
-- }]
-- }
-- }
-- ]
-- }
local json = chilkat.JsonObject.new()
local i = 0
json.i = i
json:update_string("carbonCopies[i].email", "support@chilkatsoft.com")
json:update_string("carbonCopies[i].name", "Chilkat Support")
json:update_string("carbonCopies[i].recipientId", "101")
json:update_new_object("carbonCopies[i].tabs")
i = 0
json.i = i
json:update_string("signers[i].email", "admin@chilkatsoft.com")
json:update_string("signers[i].name", "Chilkat Admin")
json:update_string("signers[i].recipientId", "1")
json:update_string("signers[i].tabs.signHereTabs[0].anchorString", "Please Sign Here")
json:update_string("signers[i].tabs.signHereTabs[0].anchorXOffset", "1")
json:update_string("signers[i].tabs.signHereTabs[0].anchorYOffset", "0")
json:update_string("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", "false")
json:update_string("signers[i].tabs.signHereTabs[0].anchorUnits", "inches")
i = i + 1
json.i = i
json:update_string("signers[i].email", "matt@chilkat.io")
json:update_string("signers[i].name", "Matt")
json:update_string("signers[i].recipientId", "2")
json:update_string("signers[i].tabs.signHereTabs[0].anchorString", "Please Also Sign Here")
json:update_string("signers[i].tabs.signHereTabs[0].anchorXOffset", "1")
json:update_string("signers[i].tabs.signHereTabs[0].anchorYOffset", "0")
json:update_string("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", "false")
json:update_string("signers[i].tabs.signHereTabs[0].anchorUnits", "inches")
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}/recipients"
local resp = chilkat.HttpResponse.new()
success = http:http_sb("POST", 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)
-- {
-- "signers": [
-- {
-- "creationReason": "sender",
-- "requireUploadSignature": "false",
-- "email": "admin@chilkatsoft.com",
-- "recipientId": "1",
-- "requireIdLookup": "false",
-- "routingOrder": "1",
-- "status": "created",
-- "completedCount": "0",
-- "deliveryMethod": "email",
-- "recipientType": "signer"
-- },
-- {
-- "creationReason": "sender",
-- "requireUploadSignature": "false",
-- "email": "matt@chilkat.io",
-- "recipientId": "2",
-- "requireIdLookup": "false",
-- "routingOrder": "1",
-- "status": "created",
-- "completedCount": "0",
-- "deliveryMethod": "email",
-- "recipientType": "signer"
-- }
-- ],
-- "agents": [],
-- "editors": [],
-- "intermediaries": [],
-- "carbonCopies": [
-- {
-- "email": "support@chilkatsoft.com",
-- "recipientId": "101",
-- "requireIdLookup": "false",
-- "routingOrder": "1",
-- "status": "created",
-- "completedCount": "0",
-- "deliveryMethod": "email",
-- "recipientType": "carboncopy"
-- }
-- ],
-- "certifiedDeliveries": [],
-- "inPersonSigners": [],
-- "seals": [],
-- "witnesses": [],
-- "recipientCount": "3"
-- }
-- 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 creationReason = ""
local requireUploadSignature = ""
local email = ""
local recipientId = ""
local requireIdLookup = ""
local routingOrder = ""
local status = ""
local completedCount = ""
local deliveryMethod = ""
local recipientType = ""
local recipientCount = json:string_of("recipientCount")
i = 0
local count_i = json:size_of_array("signers")
while i < count_i do
json.i = i
creationReason = json:string_of("signers[i].creationReason")
requireUploadSignature = json:string_of("signers[i].requireUploadSignature")
email = json:string_of("signers[i].email")
recipientId = json:string_of("signers[i].recipientId")
requireIdLookup = json:string_of("signers[i].requireIdLookup")
routingOrder = json:string_of("signers[i].routingOrder")
status = json:string_of("signers[i].status")
completedCount = json:string_of("signers[i].completedCount")
deliveryMethod = json:string_of("signers[i].deliveryMethod")
recipientType = json:string_of("signers[i].recipientType")
i = i + 1
end
i = 0
count_i = json:size_of_array("agents")
while i < count_i do
json.i = i
-- ...
i = i + 1
end
i = 0
count_i = json:size_of_array("editors")
while i < count_i do
json.i = i
-- ...
i = i + 1
end
i = 0
count_i = json:size_of_array("intermediaries")
while i < count_i do
json.i = i
-- ...
i = i + 1
end
i = 0
count_i = json:size_of_array("carbonCopies")
while i < count_i do
json.i = i
email = json:string_of("carbonCopies[i].email")
recipientId = json:string_of("carbonCopies[i].recipientId")
requireIdLookup = json:string_of("carbonCopies[i].requireIdLookup")
routingOrder = json:string_of("carbonCopies[i].routingOrder")
status = json:string_of("carbonCopies[i].status")
completedCount = json:string_of("carbonCopies[i].completedCount")
deliveryMethod = json:string_of("carbonCopies[i].deliveryMethod")
recipientType = json:string_of("carbonCopies[i].recipientType")
i = i + 1
end
i = 0
count_i = json:size_of_array("certifiedDeliveries")
while i < count_i do
json.i = i
-- ...
i = i + 1
end
i = 0
count_i = json:size_of_array("inPersonSigners")
while i < count_i do
json.i = i
-- ...
i = i + 1
end
i = 0
count_i = json:size_of_array("seals")
while i < count_i do
json.i = i
-- ...
i = i + 1
end
i = 0
count_i = json:size_of_array("witnesses")
while i < count_i do
json.i = i
-- ...
i = i + 1
end
-- If the recipient already exists within the envelope, we would get
-- a success (201) response status code, but errors within the JSON response, such as this:
-- {
-- "signers": [
-- {
-- "creationReason": "sender",
-- "requireUploadSignature": "false",
-- "email": "admin@chilkatsoft.com",
-- "recipientId": "1",
-- "requireIdLookup": "false",
-- "routingOrder": "1",
-- "status": "error",
-- "completedCount": "0",
-- "deliveryMethod": "email",
-- "errorDetails": {
-- "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
-- "message": "This recipientId already exists."
-- },
-- "recipientType": "signer"
-- },
-- {
-- "creationReason": "sender",
-- "requireUploadSignature": "false",
-- "email": "matt@chilkat.io",
-- "recipientId": "2",
-- "requireIdLookup": "false",
-- "routingOrder": "1",
-- "status": "error",
-- "completedCount": "0",
-- "deliveryMethod": "email",
-- "errorDetails": {
-- "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
-- "message": "This recipientId already exists."
-- },
-- "recipientType": "signer"
-- }
-- ],
-- "agents": [
-- ],
-- "editors": [
-- ],
-- "intermediaries": [
-- ],
-- "carbonCopies": [
-- {
-- "email": "support@chilkatsoft.com",
-- "recipientId": "101",
-- "requireIdLookup": "false",
-- "routingOrder": "1",
-- "status": "error",
-- "completedCount": "0",
-- "deliveryMethod": "email",
-- "errorDetails": {
-- "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
-- "message": "This recipientId already exists."
-- },
-- "recipientType": "carboncopy"
-- }
-- ],
-- "certifiedDeliveries": [
-- ],
-- "inPersonSigners": [
-- ],
-- "seals": [
-- ],
-- "witnesses": [
-- ],
-- "recipientCount": "3"
-- }
--