(DataFlex) 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.

Note: This example requires Chilkat v11.0.0 or greater.

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

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoHttp
    Variant vJson
Token    Handle hoJsonToken
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    Handle hoJResp
    Integer iRespStatusCode
    String sEnvelopeId
    String sUri
    String sStatusDateTime
    String sStatus
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Load a previously obtained OAuth2 access token.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/docusign.json" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoJsonToken To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Set ComAuthToken Of hoHttp To sTemp1

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "emailSubject" "Sign for Project XYZ Approval" To iSuccess

    Send ComSetRequestHeader To hoHttp "Cache-Control" "no-cache"
    Send ComSetRequestHeader To hoHttp "Accept" "application/json"

    // Use your own account ID here.
    Get ComSetUrlVar Of hoHttp "accountId" "7f3f65ed-5e87-418d-94c1-92499ddc8252" To iSuccess

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoResp to vResp
    Get ComHttpJson Of hoHttp "POST" "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes" vJson "application/json" vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get ComBodyStr Of hoResp To sTemp1
    Get ComLoad Of hoJResp sTemp1 To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    // If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    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

    Get ComStringOf Of hoJResp "envelopeId" To sEnvelopeId
    Get ComStringOf Of hoJResp "uri" To sUri
    Get ComStringOf Of hoJResp "statusDateTime" To sStatusDateTime
    Get ComStringOf Of hoJResp "status" To sStatus


End_Procedure