(Visual FoxPro) DocuSign Add Recipients to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one or more recipients to a DocuSign draft envelope.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/create/

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL loJsonToken
LOCAL lnSuccess
LOCAL loJson
LOCAL i
LOCAL loSbJson
LOCAL lcUrl
LOCAL loResp
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCreationReason
LOCAL lcRequireUploadSignature
LOCAL lcEmail
LOCAL lcRecipientId
LOCAL lcRequireIdLookup
LOCAL lcRoutingOrder
LOCAL lcStatus
LOCAL lcCompletedCount
LOCAL lcDeliveryMethod
LOCAL lcRecipientType
LOCAL lcRecipientCount
LOCAL lnCount_i

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

* Load a previously obtained OAuth2 access token.
loJsonToken = CreateObject('Chilkat_9_5_0.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/<account ID>/envelopes/<envelope ID>/recipients HTTP/1.1
* Accept: application/json
* Cache-Control: no-cache
* Authorization: Bearer eyJ0eX...
* Content-Length: ...
* Content-Type: application/json
* 
* {
*   "carbonCopies": [
*     {
*       "email": "support@chilkatsoft.com",
*       "name": "Chilkat Support",
*       "recipientId": "101",
*       "tabs": {}
*     }
*   ],
*   "signers": [
*     {
*       "email": "admin@chilkatsoft.com",
*       "name": "Chilkat Admin",
*       "recipientId": "1",
* 	 "tabs": {
* 	    "signHereTabs": [{
* 	        "anchorString": "Please Sign Here",
* 	        "anchorXOffset": "1",
* 	        "anchorYOffset": "0",
* 	        "anchorIgnoreIfNotPresent": "false",
* 	        "anchorUnits": "inches"
* 	    }]
* 	}
*     },
*     {
*       "email": "matt@chilkat.io",
*       "name": "Matt",
*       "recipientId": "2",
* 	 "tabs": {
* 	    "signHereTabs": [{
* 	        "anchorString": "Please Also Sign Here",
* 	        "anchorXOffset": "1",
* 	        "anchorYOffset": "0",
* 	        "anchorIgnoreIfNotPresent": "false",
* 	        "anchorUnits": "inches"
* 	    }]
* 	}
*     }
*   ]
* }

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
i = 0
loJson.I = i
loJson.UpdateString("carbonCopies[i].email","support@chilkatsoft.com")
loJson.UpdateString("carbonCopies[i].name","Chilkat Support")
loJson.UpdateString("carbonCopies[i].recipientId","101")
loJson.UpdateNewObject("carbonCopies[i].tabs")
i = 0
loJson.I = i
loJson.UpdateString("signers[i].email","admin@chilkatsoft.com")
loJson.UpdateString("signers[i].name","Chilkat Admin")
loJson.UpdateString("signers[i].recipientId","1")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorString","Please Sign Here")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorXOffset","1")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorYOffset","0")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent","false")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorUnits","inches")
i = i + 1
loJson.I = i
loJson.UpdateString("signers[i].email","matt@chilkat.io")
loJson.UpdateString("signers[i].name","Matt")
loJson.UpdateString("signers[i].recipientId","2")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorString","Please Also Sign Here")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorXOffset","1")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorYOffset","0")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent","false")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorUnits","inches")

loSbJson = CreateObject('Chilkat_9_5_0.StringBuilder')
loJson.EmitCompact = 0
loJson.EmitSb(loSbJson)

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")
* Use the envelope ID returned by DocuSign when creating the draft envelope).
loHttp.SetUrlVar("envelopeId","191838e0-4f61-4b78-96fd-d9dd97bb003a")

lcUrl = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients"
loResp = loHttp.PTextSb("POST",lcUrl,loSbJson,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loJson
    RELEASE loSbJson
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.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 loSbJson
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*     "signers": [
*         {
*             "creationReason": "sender",
*             "requireUploadSignature": "false",
*             "email": "admin@chilkatsoft.com",
*             "recipientId": "1",
*             "requireIdLookup": "false",
*             "routingOrder": "1",
*             "status": "created",
*             "completedCount": "0",
*             "deliveryMethod": "email",
*             "recipientType": "signer"
*         },
*         {
*             "creationReason": "sender",
*             "requireUploadSignature": "false",
*             "email": "matt@chilkat.io",
*             "recipientId": "2",
*             "requireIdLookup": "false",
*             "routingOrder": "1",
*             "status": "created",
*             "completedCount": "0",
*             "deliveryMethod": "email",
*             "recipientType": "signer"
*         }
*     ],
*     "agents": [],
*     "editors": [],
*     "intermediaries": [],
*     "carbonCopies": [
*         {
*             "email": "support@chilkatsoft.com",
*             "recipientId": "101",
*             "requireIdLookup": "false",
*             "routingOrder": "1",
*             "status": "created",
*             "completedCount": "0",
*             "deliveryMethod": "email",
*             "recipientType": "carboncopy"
*         }
*     ],
*     "certifiedDeliveries": [],
*     "inPersonSigners": [],
*     "seals": [],
*     "witnesses": [],
*     "recipientCount": "3"
* }

* Sample code for parsing the JSON response...
* Use the following online tool to generate parsing code from sample JSON:
* Generate Parsing Code from JSON

lcRecipientCount = loJson.StringOf("recipientCount")
i = 0
lnCount_i = loJson.SizeOfArray("signers")
DO WHILE i < lnCount_i
    loJson.I = i
    lcCreationReason = loJson.StringOf("signers[i].creationReason")
    lcRequireUploadSignature = loJson.StringOf("signers[i].requireUploadSignature")
    lcEmail = loJson.StringOf("signers[i].email")
    lcRecipientId = loJson.StringOf("signers[i].recipientId")
    lcRequireIdLookup = loJson.StringOf("signers[i].requireIdLookup")
    lcRoutingOrder = loJson.StringOf("signers[i].routingOrder")
    lcStatus = loJson.StringOf("signers[i].status")
    lcCompletedCount = loJson.StringOf("signers[i].completedCount")
    lcDeliveryMethod = loJson.StringOf("signers[i].deliveryMethod")
    lcRecipientType = loJson.StringOf("signers[i].recipientType")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJson.SizeOfArray("agents")
DO WHILE i < lnCount_i
    loJson.I = i
    *    ...
    i = i + 1
ENDDO
i = 0
lnCount_i = loJson.SizeOfArray("editors")
DO WHILE i < lnCount_i
    loJson.I = i
    *    ...
    i = i + 1
ENDDO
i = 0
lnCount_i = loJson.SizeOfArray("intermediaries")
DO WHILE i < lnCount_i
    loJson.I = i
    *    ...
    i = i + 1
ENDDO
i = 0
lnCount_i = loJson.SizeOfArray("carbonCopies")
DO WHILE i < lnCount_i
    loJson.I = i
    lcEmail = loJson.StringOf("carbonCopies[i].email")
    lcRecipientId = loJson.StringOf("carbonCopies[i].recipientId")
    lcRequireIdLookup = loJson.StringOf("carbonCopies[i].requireIdLookup")
    lcRoutingOrder = loJson.StringOf("carbonCopies[i].routingOrder")
    lcStatus = loJson.StringOf("carbonCopies[i].status")
    lcCompletedCount = loJson.StringOf("carbonCopies[i].completedCount")
    lcDeliveryMethod = loJson.StringOf("carbonCopies[i].deliveryMethod")
    lcRecipientType = loJson.StringOf("carbonCopies[i].recipientType")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJson.SizeOfArray("certifiedDeliveries")
DO WHILE i < lnCount_i
    loJson.I = i
    *    ...
    i = i + 1
ENDDO
i = 0
lnCount_i = loJson.SizeOfArray("inPersonSigners")
DO WHILE i < lnCount_i
    loJson.I = i
    *    ...
    i = i + 1
ENDDO
i = 0
lnCount_i = loJson.SizeOfArray("seals")
DO WHILE i < lnCount_i
    loJson.I = i
    *    ...
    i = i + 1
ENDDO
i = 0
lnCount_i = loJson.SizeOfArray("witnesses")
DO WHILE i < lnCount_i
    loJson.I = i
    *    ...
    i = i + 1
ENDDO

* If the recipient already exists within the envelope, we would get
* a success (201) response status code, but errors within the JSON response, such as this:

* {
*   "signers": [
*     {
*       "creationReason": "sender",
*       "requireUploadSignature": "false",
*       "email": "admin@chilkatsoft.com",
*       "recipientId": "1",
*       "requireIdLookup": "false",
*       "routingOrder": "1",
*       "status": "error",
*       "completedCount": "0",
*       "deliveryMethod": "email",
*       "errorDetails": {
*         "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
*         "message": "This recipientId already exists."
*       },
*       "recipientType": "signer"
*     },
*     {
*       "creationReason": "sender",
*       "requireUploadSignature": "false",
*       "email": "matt@chilkat.io",
*       "recipientId": "2",
*       "requireIdLookup": "false",
*       "routingOrder": "1",
*       "status": "error",
*       "completedCount": "0",
*       "deliveryMethod": "email",
*       "errorDetails": {
*         "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
*         "message": "This recipientId already exists."
*       },
*       "recipientType": "signer"
*     }
*   ],
*   "agents": [
*   ],
*   "editors": [
*   ],
*   "intermediaries": [
*   ],
*   "carbonCopies": [
*     {
*       "email": "support@chilkatsoft.com",
*       "recipientId": "101",
*       "requireIdLookup": "false",
*       "routingOrder": "1",
*       "status": "error",
*       "completedCount": "0",
*       "deliveryMethod": "email",
*       "errorDetails": {
*         "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
*         "message": "This recipientId already exists."
*       },
*       "recipientType": "carboncopy"
*     }
*   ],
*   "certifiedDeliveries": [
*   ],
*   "inPersonSigners": [
*   ],
*   "seals": [
*   ],
*   "witnesses": [
*   ],
*   "recipientCount": "3"
* }
* 

RELEASE loHttp
RELEASE loJsonToken
RELEASE loJson
RELEASE loSbJson
RELEASE loJResp