Objective-C

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. Objective-C

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

BOOL success = NO;

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"emailSubject" value: @"Sign for Project XYZ Approval"];

[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"];

CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpJson: @"POST" url: @"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes" json: json contentType: @"application/json" response: resp];
if (success == 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)

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

NSString *envelopeId = [jResp StringOf: @"envelopeId"];
NSString *uri = [jResp StringOf: @"uri"];
NSString *statusDateTime = [jResp StringOf: @"statusDateTime"];
NSString *status = [jResp StringOf: @"status"];