JavaScript

DocuSign Add Documents to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one or more additional documents to a DocuSign draft envelope. JavaScript

var success = false;

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

var http = new CkHttp();

// Load a previously obtained OAuth2 access token.
var jsonToken = new CkJsonObject();
success = jsonToken.LoadFile("qa_data/tokens/docusign.json");
if (success == false) {
    console.log(jsonToken.LastErrorText);
    return;
}

// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.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": "hello.pdf",
// 		"pages": "1",
// 		"documentBase64": "<insert base64 content here>"
// 		},
// 		{
// 		"documentId": "2",
// 		"name": "hello2.pdf",
// 		"pages": "1",
// 		"documentBase64": "<insert base64 content here>"
// 		}
// 	]
// }

var bd1 = new CkBinData();
success = bd1.LoadFile("qa_data/pdf/hello.pdf");
var bd2 = new CkBinData();
success = bd2.LoadFile("qa_data/pdf/hello2.pdf");

var json = new CkJsonObject();
var i = 0;
json.I = i;
json.UpdateString("documents[i].documentId","1");
json.UpdateString("documents[i].name","hello.pdf");
json.UpdateString("documents[i].pages","1");
json.UpdateString("documents[i].documentBase64",bd1.GetEncoded("base64"));
i = i+1;
json.I = i;
json.UpdateString("documents[i].documentId","2");
json.UpdateString("documents[i].name","hello2.pdf");
json.UpdateString("documents[i].pages","1");
json.UpdateString("documents[i].documentBase64",bd2.GetEncoded("base64"));

var sbJson = new CkStringBuilder();
json.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","e01f2043-3850-4fcb-afd1-b1726216e099");

var url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents";
var resp = new CkHttpResponse();
success = http.HttpSb("PUT",url,sbJson,"utf-8","application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var jResp = new CkJsonObject();
jResp.Load(resp.BodyStr);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

// 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": "hello.pdf",
//       "type": "content",
//       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
//       "order": "3",
//       "containsPdfFormFields": "false",
//       "templateRequired": "false",
//       "authoritativeCopy": "false"
//     },
//     {
//       "documentId": "2",
//       "documentIdGuid": "2cbd0fcc-c1ca-4a3a-b8b5-fe252dd89731",
//       "name": "hello2.pdf",
//       "type": "content",
//       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/2",
//       "order": "4",
//       "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

var documentId;
var documentIdGuid;
var name;
var v_type;
var uri;
var order;
var containsPdfFormFields;
var templateRequired;
var authoritativeCopy;

var envelopeId = jResp.StringOf("envelopeId");
i = 0;
var count_i = jResp.SizeOfArray("envelopeDocuments");
while (i < count_i) {
    jResp.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;
}