(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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

    let http = CkoHttp()!

    // Load a previously obtained OAuth2 access token.
    let jsonToken = CkoJsonObject()!
    var success: Bool = jsonToken.loadFile("qa_data/tokens/docusign.json")
    if success == false {
        print("\(jsonToken.lastErrorText!)")
        return
    }

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    http.authToken = jsonToken.string(of: "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"
    // 	    }]
    // 	}
    //     }
    //   ]
    // }

    let json = CkoJsonObject()!
    var i: Int = 0
    json.i = i
    json.update("carbonCopies[i].email", value: "support@chilkatsoft.com")
    json.update("carbonCopies[i].name", value: "Chilkat Support")
    json.update("carbonCopies[i].recipientId", value: "101")
    json.updateNewObject("carbonCopies[i].tabs")
    i = 0
    json.i = i
    json.update("signers[i].email", value: "admin@chilkatsoft.com")
    json.update("signers[i].name", value: "Chilkat Admin")
    json.update("signers[i].recipientId", value: "1")
    json.update("signers[i].tabs.signHereTabs[0].anchorString", value: "Please Sign Here")
    json.update("signers[i].tabs.signHereTabs[0].anchorXOffset", value: "1")
    json.update("signers[i].tabs.signHereTabs[0].anchorYOffset", value: "0")
    json.update("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", value: "false")
    json.update("signers[i].tabs.signHereTabs[0].anchorUnits", value: "inches")
    i = i + 1
    json.i = i
    json.update("signers[i].email", value: "matt@chilkat.io")
    json.update("signers[i].name", value: "Matt")
    json.update("signers[i].recipientId", value: "2")
    json.update("signers[i].tabs.signHereTabs[0].anchorString", value: "Please Also Sign Here")
    json.update("signers[i].tabs.signHereTabs[0].anchorXOffset", value: "1")
    json.update("signers[i].tabs.signHereTabs[0].anchorYOffset", value: "0")
    json.update("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", value: "false")
    json.update("signers[i].tabs.signHereTabs[0].anchorUnits", value: "inches")

    let sbJson = CkoStringBuilder()!
    json.emitCompact = false
    json.emitSb(sbJson)

    http.setRequestHeader("Cache-Control", value: "no-cache")
    http.setRequestHeader("Accept", value: "application/json")

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

    var url: String? = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients"
    var resp: CkoHttpResponse? = http.pTextSb("POST", url: url, textData: sbJson, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.load(resp!.bodyStr)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    // If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var creationReason: String?
    var requireUploadSignature: String?
    var email: String?
    var recipientId: String?
    var requireIdLookup: String?
    var routingOrder: String?
    var status: String?
    var completedCount: String?
    var deliveryMethod: String?
    var recipientType: String?

    var recipientCount: String? = json.string(of: "recipientCount")
    i = 0
    var count_i: Int = json.size(ofArray: "signers").intValue
    while i < count_i {
        json.i = i
        creationReason = json.string(of: "signers[i].creationReason")
        requireUploadSignature = json.string(of: "signers[i].requireUploadSignature")
        email = json.string(of: "signers[i].email")
        recipientId = json.string(of: "signers[i].recipientId")
        requireIdLookup = json.string(of: "signers[i].requireIdLookup")
        routingOrder = json.string(of: "signers[i].routingOrder")
        status = json.string(of: "signers[i].status")
        completedCount = json.string(of: "signers[i].completedCount")
        deliveryMethod = json.string(of: "signers[i].deliveryMethod")
        recipientType = json.string(of: "signers[i].recipientType")
        i = i + 1
    }

    i = 0
    count_i = json.size(ofArray: "agents").intValue
    while i < count_i {
        json.i = i
        //    ...
        i = i + 1
    }

    i = 0
    count_i = json.size(ofArray: "editors").intValue
    while i < count_i {
        json.i = i
        //    ...
        i = i + 1
    }

    i = 0
    count_i = json.size(ofArray: "intermediaries").intValue
    while i < count_i {
        json.i = i
        //    ...
        i = i + 1
    }

    i = 0
    count_i = json.size(ofArray: "carbonCopies").intValue
    while i < count_i {
        json.i = i
        email = json.string(of: "carbonCopies[i].email")
        recipientId = json.string(of: "carbonCopies[i].recipientId")
        requireIdLookup = json.string(of: "carbonCopies[i].requireIdLookup")
        routingOrder = json.string(of: "carbonCopies[i].routingOrder")
        status = json.string(of: "carbonCopies[i].status")
        completedCount = json.string(of: "carbonCopies[i].completedCount")
        deliveryMethod = json.string(of: "carbonCopies[i].deliveryMethod")
        recipientType = json.string(of: "carbonCopies[i].recipientType")
        i = i + 1
    }

    i = 0
    count_i = json.size(ofArray: "certifiedDeliveries").intValue
    while i < count_i {
        json.i = i
        //    ...
        i = i + 1
    }

    i = 0
    count_i = json.size(ofArray: "inPersonSigners").intValue
    while i < count_i {
        json.i = i
        //    ...
        i = i + 1
    }

    i = 0
    count_i = json.size(ofArray: "seals").intValue
    while i < count_i {
        json.i = i
        //    ...
        i = i + 1
    }

    i = 0
    count_i = json.size(ofArray: "witnesses").intValue
    while i < count_i {
        json.i = i
        //    ...
        i = i + 1
    }

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

}