(PowerShell) DocuSign Send a Draft Envelope

See more DocuSign Examples

Demonstrates how to send a DocuSign draft envelope.

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

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> HTTP/1.1
# Accept: application/json
# Cache-Control: no-cache
# Authorization: Bearer eyJ0eX...
# Content-Length: ...
# Content-Type: application/json
# 
# {
#   "status": "sent"
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("status","sent")

$sbJson = New-Object Chilkat.StringBuilder
$json.EmitCompact = $false
$json.EmitSb($sbJson)

$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}"
$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)

# If the envelope you're trying to send is not yet completed, you'll get an error such as this:
# {
#   "errorCode": "ENVELOPE_IS_INCOMPLETE",
#   "message": "The Envelope is not Complete. A Complete Envelope Requires Documents, Recipients, Tabs, and a Subject Line."
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON