Xojo Plugin

DocuSign Send a Draft Envelope

See more DocuSign Examples

Demonstrates how to send a DocuSign draft envelope. Xojo Plugin

Dim success As Boolean
success = False

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

Dim http As New Chilkat.Http

// Load a previously obtained OAuth2 access token.
Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If (success = False) Then
    System.DebugLog(jsonToken.LastErrorText)
    Return
End If

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

Dim json As New Chilkat.JsonObject
success = json.UpdateString("status","sent")

Dim sbJson As New Chilkat.StringBuilder
json.EmitCompact = False
success = json.EmitSb(sbJson)

http.SetRequestHeader "Cache-Control","no-cache"
http.SetRequestHeader "Accept","application/json"

// Use your own account ID here.
success = http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
// Use the envelope ID returned by DocuSign when creating the draft envelope).
success = http.SetUrlVar("envelopeId","cee4191c-f94e-4089-9d7c-8033685cbc1a")

Dim url As String
url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}"

Dim resp As New Chilkat.HttpResponse
success = http.HttpSb("PUT",url,sbJson,"utf-8","application/json",resp)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.Load(resp.BodyStr)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")
    Return
End If

// 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