Objective-C / DocuSign Click API / 2. Create Envelope in Draft Stage
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.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];
BOOL success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "documents": [
// {
// "documentBase64": "{{documentBase64}}",
// "documentId": "123",
// "fileExtension": "pdf",
// "name": "document"
// }
// ],
// "emailSubject": "Simple Signing Example",
// "recipients": {
// "signers": [
// {
// "email": "{{email}}",
// "name": "{{name}}",
// "recipientId": "{{recipientId}}"
// }
// ]
// },
// "status": "created"
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"documents[0].documentBase64" value: @"{{documentBase64}}"];
[json UpdateString: @"documents[0].documentId" value: @"123"];
[json UpdateString: @"documents[0].fileExtension" value: @"pdf"];
[json UpdateString: @"documents[0].name" value: @"document"];
[json UpdateString: @"emailSubject" value: @"Simple Signing Example"];
[json UpdateString: @"recipients.signers[0].email" value: @"{{email}}"];
[json UpdateString: @"recipients.signers[0].name" value: @"{{name}}"];
[json UpdateString: @"recipients.signers[0].recipientId" value: @"{{recipientId}}"];
[json UpdateString: @"status" value: @"created"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"documents": [
{
"documentBase64": {{document}},
"documentId": "123",
"fileExtension": "pdf",
"name": "document"
}
],
"emailSubject": "Simple Signing Example",
"recipients": {
"signers": [
{
"email": {{user1}},
"name": {{user1_name}},
"recipientId": "{{recipientId}}"
}
]
},
"status": "created"
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes
Postman Collection Item JSON
{
"name": "2. Create Envelope in Draft Stage",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"documentBase64\": {{document}},\n \"documentId\": \"123\",\n \"fileExtension\": \"pdf\",\n \"name\": \"document\"\n }\n ],\n \"emailSubject\": \"Simple Signing Example\",\n \"recipients\": {\n \"signers\": [\n {\n \"email\": {{user1}},\n \"name\": {{user1_name}},\n \"recipientId\": \"{{recipientId}}\"\n }\n ]\n },\n \"status\": \"created\"\n}"
},
"url": {
"raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes",
"host": [
"{{baseUrl}}"
],
"path": [
"{{apiVersion}}",
"accounts",
"{{accountId}}",
"envelopes"
]
},
"description": "In this example, we are creating an envelope similar to the previous step. However, we are keeping it in `draft` stage so can continue to make changes to it. If the status was set to `sent` the envelope would be sent to users."
},
"response": [
]
}