(PowerShell) 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 .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

# Load a previously obtained OAuth2 access token.
$jsonToken = New-Object Chilkat.JsonObject
$success = $jsonToken.LoadFile("qa_data/tokens/docusign.json")
if ($success -eq $false) {
    $($jsonToken.LastErrorText)
    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>"
# 		}
# 	]
# }

$bd1 = New-Object Chilkat.BinData
$success = $bd1.LoadFile("qa_data/pdf/project_xyz.pdf")

$json = New-Object 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"))

$sbJson = New-Object 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","0b437b95-cc50-475f-8dec-65bae9f27d09")

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

$jResp = New-Object Chilkat.JsonObject
$jResp.Load($resp.BodyStr)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

# If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

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