(Node.js) 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/

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var http = new chilkat.Http();

    // Load a previously obtained OAuth2 access token.
    var jsonToken = new chilkat.JsonObject();
    var 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": "project_xyz.pdf",
    // 		"pages": "1",
    // 		"documentBase64": "<insert base64 content here>"
    // 		}
    // 	]
    // }

    var bd1 = new chilkat.BinData();
    success = bd1.LoadFile("qa_data/pdf/project_xyz.pdf");

    var json = new chilkat.JsonObject();
    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"));

    var sbJson = new chilkat.StringBuilder();
    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","cee4191c-f94e-4089-9d7c-8033685cbc1a");

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

    var jResp = new chilkat.JsonObject();
    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": "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

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

    var envelopeId = jResp.StringOf("envelopeId");
    var 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;
    }


}

chilkatExample();