(Perl) 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.

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

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use 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 == 0) {
    print $jsonToken->lastErrorText() . "\r\n";
    exit;
}

# 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": "hello.pdf",
# 		"pages": "1",
# 		"documentBase64": "<insert base64 content here>"
# 		},
# 		{
# 		"documentId": "2",
# 		"name": "hello2.pdf",
# 		"pages": "1",
# 		"documentBase64": "<insert base64 content here>"
# 		}
# 	]
# }

$bd1 = chilkat::CkBinData->new();
$success = $bd1->LoadFile("qa_data/pdf/hello.pdf");
$bd2 = chilkat::CkBinData->new();
$success = $bd2->LoadFile("qa_data/pdf/hello2.pdf");

$json = chilkat::CkJsonObject->new();
$i = 0;
$json->put_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->put_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"));

$sbJson = chilkat::CkStringBuilder->new();
$json->put_EmitCompact(0);
$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","da9fb811-e6a4-48c0-a9fb-81ed18b989af");

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

$jResp = chilkat::CkJsonObject->new();
$jResp->Load($resp->bodyStr());
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\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 . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$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;
}