(Visual FoxPro) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL loJsonToken
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcEnvelopeId
LOCAL lcUri
LOCAL lcStatusDateTime
LOCAL lcStatus

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Load a previously obtained OAuth2 access token.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/docusign.json")
IF (lnSuccess = 0) THEN
    ? loJsonToken.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    CANCEL
ENDIF

* Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
loHttp.AuthToken = loJsonToken.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"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("emailSubject","Sign for Project XYZ Approval")

loHttp.SetRequestHeader("Cache-Control","no-cache")
loHttp.SetRequestHeader("Accept","application/json")

* Use your own account ID here.
loHttp.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")

* PostJson automatically sets the Content-Type header to "application/json"
loResp = loHttp.PostJson("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes",loJson.Emit())
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.Load(loResp.BodyStr)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

* If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loJson
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcEnvelopeId = loJResp.StringOf("envelopeId")
lcUri = loJResp.StringOf("uri")
lcStatusDateTime = loJResp.StringOf("statusDateTime")
lcStatus = loJResp.StringOf("status")

RELEASE loHttp
RELEASE loJsonToken
RELEASE loJson
RELEASE loJResp