(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Load a previously obtained OAuth2 access token.
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
if (success == false)
    print jsonToken.lastErrorText() + "\n";
    exit
end

# Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.put_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 = Chilkat::CkJsonObject.new()
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 is a CkHttpResponse
resp = http.PostJson("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes",json.emit())
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.Load(resp.bodyStr())
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

# If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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