(PowerShell) DocuSign Create Empty Envelope Draft

See more DocuSign Examples

Creates an empty envelope draft. The JSON response includes the envelope ID which can be used to add documents, recipients, etc. until the envelope is ready to send.

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

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)

# POST https://demo.docusign.net/restapi/v2.1/accounts/7f3f65ed-5e87-418d-94c1-92499ddc8252/envelopes HTTP/1.1
# Accept: application/json
# Cache-Control: no-cache
# Authorization: Bearer eyJ0eX...
# Content-Length: ...
# Content-Type: application/json
# 
# {
#   "emailSubject": "Sign for Project XYZ Approval"
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("emailSubject","Sign for Project XYZ Approval")

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

# PostJson automatically sets the Content-Type header to "application/json"
$resp = $http.PostJson("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes",$json.Emit())
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": "4943126a-a6e0-40ca-8707-50f22bf3888c",
#   "uri": "/envelopes/4943126a-a6e0-40ca-8707-50f22bf3888c",
#   "statusDateTime": "2021-01-23T20:21:42.1400000Z",
#   "status": "created"
# }

# 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")
$uri = $jResp.StringOf("uri")
$statusDateTime = $jResp.StringOf("statusDateTime")
$status = $jResp.StringOf("status")