(PHP ActiveX) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Load a previously obtained OAuth2 access token.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonToken = new COM("Chilkat.JsonObject");
$success = $jsonToken->LoadFile('qa_data/tokens/docusign.json');
if ($success == 0) {
    print $jsonToken->LastErrorText . "\n";
    exit;
}

// 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>"
// 		}
// 	]
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.BinData')
$bd1 = new COM("Chilkat.BinData");
$success = $bd1->LoadFile('qa_data/pdf/project_xyz.pdf');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("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'));

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbJson = new COM("Chilkat.StringBuilder");
$json->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','cee4191c-f94e-4089-9d7c-8033685cbc1a');

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->Load($resp->BodyStr);
$jResp->EmitCompact = 0;

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->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\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": "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->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;
}


?>