(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# Load a previously obtained OAuth2 access token.
set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/docusign.json"]
if {$success == 0} then {
    puts [CkJsonObject_lastErrorText $jsonToken]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    exit
}

# Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
CkHttp_put_AuthToken $http [CkJsonObject_stringOf $jsonToken "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"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "emailSubject" "Sign for Project XYZ Approval"

CkHttp_SetRequestHeader $http "Cache-Control" "no-cache"
CkHttp_SetRequestHeader $http "Accept" "application/json"

# Use your own account ID here.
CkHttp_SetUrlVar $http "accountId" "7f3f65ed-5e87-418d-94c1-92499ddc8252"

# PostJson automatically sets the Content-Type header to "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson $http "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes" [CkJsonObject_emit $json]]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $json
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_Load $jResp [CkHttpResponse_bodyStr $resp]
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

# If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $json
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set envelopeId [CkJsonObject_stringOf $jResp "envelopeId"]
set uri [CkJsonObject_stringOf $jResp "uri"]
set statusDateTime [CkJsonObject_stringOf $jResp "statusDateTime"]
set status [CkJsonObject_stringOf $jResp "status"]

delete_CkHttp $http
delete_CkJsonObject $jsonToken
delete_CkJsonObject $json
delete_CkJsonObject $jResp