(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Load a previously obtained OAuth2 access token.
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/docusign.json")
    If success = 0
        Debug CkJsonObject::ckLastErrorText(jsonToken)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    ; Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(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"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"emailSubject","Sign for Project XYZ Approval")

    CkHttp::ckSetRequestHeader(http,"Cache-Control","no-cache")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    ; Use your own account ID here.
    CkHttp::ckSetUrlVar(http,"accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")

    ; PostJson automatically sets the Content-Type header to "application/json"
    resp.i = CkHttp::ckPostJson(http,"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes",CkJsonObject::ckEmit(json))
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(jResp,CkHttpResponse::ckBodyStr(resp))
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    ; If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        CkJsonObject::ckDispose(json)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

    envelopeId.s = CkJsonObject::ckStringOf(jResp,"envelopeId")
    uri.s = CkJsonObject::ckStringOf(jResp,"uri")
    statusDateTime.s = CkJsonObject::ckStringOf(jResp,"statusDateTime")
    status.s = CkJsonObject::ckStringOf(jResp,"status")


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(jsonToken)
    CkJsonObject::ckDispose(json)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure