(VB.NET) 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 .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Dim http As New Chilkat.Http

' Load a previously obtained OAuth2 access token.
Dim jsonToken As New Chilkat.JsonObject
Dim success As Boolean = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If (success = False) Then
    Debug.WriteLine(jsonToken.LastErrorText)
    Exit Sub
End If


' Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.AuthToken = jsonToken.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"
' 	    }]
' 	}
'     }
'   ]
' }


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

Dim sbJson As New Chilkat.StringBuilder
json.EmitCompact = False
json.EmitSb(sbJson)

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

' Use your own account ID here.
http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
' Use the envelope ID returned by DocuSign when creating the draft envelope).
http.SetUrlVar("envelopeId","191838e0-4f61-4b78-96fd-d9dd97bb003a")

Dim url As String = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients"
Dim resp As Chilkat.HttpResponse = http.PTextSb("POST",url,sbJson,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If



Dim jResp As New Chilkat.JsonObject
jResp.Load(resp.BodyStr)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

' If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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

Dim creationReason As String
Dim requireUploadSignature As String
Dim email As String
Dim recipientId As String
Dim requireIdLookup As String
Dim routingOrder As String
Dim status As String
Dim completedCount As String
Dim deliveryMethod As String
Dim recipientType As String

Dim recipientCount As String = json.StringOf("recipientCount")
i = 0
Dim count_i As Integer = json.SizeOfArray("signers")
While i < count_i
    json.I = i
    creationReason = json.StringOf("signers[i].creationReason")
    requireUploadSignature = json.StringOf("signers[i].requireUploadSignature")
    email = json.StringOf("signers[i].email")
    recipientId = json.StringOf("signers[i].recipientId")
    requireIdLookup = json.StringOf("signers[i].requireIdLookup")
    routingOrder = json.StringOf("signers[i].routingOrder")
    status = json.StringOf("signers[i].status")
    completedCount = json.StringOf("signers[i].completedCount")
    deliveryMethod = json.StringOf("signers[i].deliveryMethod")
    recipientType = json.StringOf("signers[i].recipientType")
    i = i + 1
End While
i = 0
count_i = json.SizeOfArray("agents")
While i < count_i
    json.I = i
    '    ...
    i = i + 1
End While
i = 0
count_i = json.SizeOfArray("editors")
While i < count_i
    json.I = i
    '    ...
    i = i + 1
End While
i = 0
count_i = json.SizeOfArray("intermediaries")
While i < count_i
    json.I = i
    '    ...
    i = i + 1
End While
i = 0
count_i = json.SizeOfArray("carbonCopies")
While i < count_i
    json.I = i
    email = json.StringOf("carbonCopies[i].email")
    recipientId = json.StringOf("carbonCopies[i].recipientId")
    requireIdLookup = json.StringOf("carbonCopies[i].requireIdLookup")
    routingOrder = json.StringOf("carbonCopies[i].routingOrder")
    status = json.StringOf("carbonCopies[i].status")
    completedCount = json.StringOf("carbonCopies[i].completedCount")
    deliveryMethod = json.StringOf("carbonCopies[i].deliveryMethod")
    recipientType = json.StringOf("carbonCopies[i].recipientType")
    i = i + 1
End While
i = 0
count_i = json.SizeOfArray("certifiedDeliveries")
While i < count_i
    json.I = i
    '    ...
    i = i + 1
End While
i = 0
count_i = json.SizeOfArray("inPersonSigners")
While i < count_i
    json.I = i
    '    ...
    i = i + 1
End While
i = 0
count_i = json.SizeOfArray("seals")
While i < count_i
    json.I = i
    '    ...
    i = i + 1
End While
i = 0
count_i = json.SizeOfArray("witnesses")
While i < count_i
    json.I = i
    '    ...
    i = i + 1
End While



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