(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];

// Load a previously obtained OAuth2 access token.
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
BOOL success = [jsonToken LoadFile: @"qa_data/tokens/docusign.json"];
if (success == NO) {
    NSLog(@"%@",jsonToken.LastErrorText);
    return;
}

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
int i = 0;
json.I = [NSNumber numberWithInt: i];
[json UpdateString: @"carbonCopies[i].email" value: @"support@chilkatsoft.com"];
[json UpdateString: @"carbonCopies[i].name" value: @"Chilkat Support"];
[json UpdateString: @"carbonCopies[i].recipientId" value: @"101"];
[json UpdateNewObject: @"carbonCopies[i].tabs"];
i = 0;
json.I = [NSNumber numberWithInt: i];
[json UpdateString: @"signers[i].email" value: @"admin@chilkatsoft.com"];
[json UpdateString: @"signers[i].name" value: @"Chilkat Admin"];
[json UpdateString: @"signers[i].recipientId" value: @"1"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorString" value: @"Please Sign Here"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorXOffset" value: @"1"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorYOffset" value: @"0"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent" value: @"false"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorUnits" value: @"inches"];
i = i + 1;
json.I = [NSNumber numberWithInt: i];
[json UpdateString: @"signers[i].email" value: @"matt@chilkat.io"];
[json UpdateString: @"signers[i].name" value: @"Matt"];
[json UpdateString: @"signers[i].recipientId" value: @"2"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorString" value: @"Please Also Sign Here"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorXOffset" value: @"1"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorYOffset" value: @"0"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent" value: @"false"];
[json UpdateString: @"signers[i].tabs.signHereTabs[0].anchorUnits" value: @"inches"];

CkoStringBuilder *sbJson = [[CkoStringBuilder alloc] init];
json.EmitCompact = NO;
[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"];

NSString *url = @"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients";
CkoHttpResponse *resp = [http PTextSb: @"POST" url: url textData: sbJson charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp Load: resp.BodyStr];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

NSString *creationReason = 0;
NSString *requireUploadSignature = 0;
NSString *email = 0;
NSString *recipientId = 0;
NSString *requireIdLookup = 0;
NSString *routingOrder = 0;
NSString *status = 0;
NSString *completedCount = 0;
NSString *deliveryMethod = 0;
NSString *recipientType = 0;

NSString *recipientCount = [json StringOf: @"recipientCount"];
i = 0;
int count_i = [[json SizeOfArray: @"signers"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: 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;
}

i = 0;
count_i = [[json SizeOfArray: @"agents"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: i];
    //    ...
    i = i + 1;
}

i = 0;
count_i = [[json SizeOfArray: @"editors"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: i];
    //    ...
    i = i + 1;
}

i = 0;
count_i = [[json SizeOfArray: @"intermediaries"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: i];
    //    ...
    i = i + 1;
}

i = 0;
count_i = [[json SizeOfArray: @"carbonCopies"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: 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;
}

i = 0;
count_i = [[json SizeOfArray: @"certifiedDeliveries"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: i];
    //    ...
    i = i + 1;
}

i = 0;
count_i = [[json SizeOfArray: @"inPersonSigners"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: i];
    //    ...
    i = i + 1;
}

i = 0;
count_i = [[json SizeOfArray: @"seals"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: i];
    //    ...
    i = i + 1;
}

i = 0;
count_i = [[json SizeOfArray: @"witnesses"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: 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"
// }
//