B4X Requires Chilkat v11.0.0+

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. B4X

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("http")

'  Load a previously obtained OAuth2 access token.
Dim jsonToken As ChilkatJsonObject
jsonToken.Initialize
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If success = False Then
    Log(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)

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

Dim json As ChilkatJsonObject
json.Initialize
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")

Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes", json, "application/json", resp)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.Load(resp.BodyStr)
jResp.EmitCompact = False

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

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


'  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

Dim envelopeId As String = jResp.StringOf("envelopeId")
Dim uri As String = jResp.StringOf("uri")
Dim statusDateTime As String = jResp.StringOf("statusDateTime")
Dim status As String = jResp.StringOf("status")