(Ruby) DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one document to a DocuSign draft envelope.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/updatelist/

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Load a previously obtained OAuth2 access token.
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
if (success == false)
    print jsonToken.lastErrorText() + "\n";
    exit
end

# Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.put_AuthToken(jsonToken.stringOf("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>/documents HTTP/1.1
# Expect: 100-continue
# Accept: application/json
# Cache-Control: no-cache
# Authorization: Bearer eyJ0eX...
# Content-Length: ...
# Content-Type: application/json
# 
# {
# 	"documents": [
# 		{
# 		"documentId": "1",
# 		"name": "project_xyz.pdf",
# 		"pages": "1",
# 		"documentBase64": "<insert base64 content here>"
# 		}
# 	]
# }

bd1 = Chilkat::CkBinData.new()
success = bd1.LoadFile("qa_data/pdf/project_xyz.pdf")

json = Chilkat::CkJsonObject.new()
json.UpdateString("documents[0].documentId","1")
json.UpdateString("documents[0].name","project_xyz.pdf")
json.UpdateString("documents[0].pages","1")
json.UpdateString("documents[0].documentBase64",bd1.getEncoded("base64"))

sbJson = Chilkat::CkStringBuilder.new()
json.put_EmitCompact(false)
json.EmitSb(sbJson)

http.SetRequestHeader("Expect","100-continue")
http.SetRequestHeader("Cache-Control","no-cache")
http.SetRequestHeader("Accept","application/json")

# Use your own account ID here.
http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
# Use the envelope ID returned by DocuSign when creating the draft envelope).
http.SetUrlVar("envelopeId","0b437b95-cc50-475f-8dec-65bae9f27d09")

url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
# resp is a CkHttpResponse
resp = http.PTextSb("PUT",url,sbJson,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.Load(resp.bodyStr())
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

# If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "envelopeId": "da9fb811-e6a4-48c0-a9fb-81ed18b989af",
#   "envelopeDocuments": [
#     {
#       "documentId": "1",
#       "documentIdGuid": "38e919fc-0a77-4b0c-9da0-e3530f4e6fc7",
#       "name": "project_xyz.pdf",
#       "type": "content",
#       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
#       "order": "3",
#       "containsPdfFormFields": "false",
#       "templateRequired": "false",
#       "authoritativeCopy": "false"
#     }
#   ]
# }

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

envelopeId = jResp.stringOf("envelopeId")
i = 0
count_i = jResp.SizeOfArray("envelopeDocuments")
while i < count_i
    jResp.put_I(i)
    documentId = jResp.stringOf("envelopeDocuments[i].documentId")
    documentIdGuid = jResp.stringOf("envelopeDocuments[i].documentIdGuid")
    name = jResp.stringOf("envelopeDocuments[i].name")
    v_type = jResp.stringOf("envelopeDocuments[i].type")
    uri = jResp.stringOf("envelopeDocuments[i].uri")
    order = jResp.stringOf("envelopeDocuments[i].order")
    containsPdfFormFields = jResp.stringOf("envelopeDocuments[i].containsPdfFormFields")
    templateRequired = jResp.stringOf("envelopeDocuments[i].templateRequired")
    authoritativeCopy = jResp.stringOf("envelopeDocuments[i].authoritativeCopy")
    i = i + 1
end