Zig
Zig
DocuSign Add Recipients to a Draft Envelope
See more DocuSign Examples
Demonstrates how to add one or more recipients to a DocuSign draft envelope.Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
const http = try chilkat.Http.init();
defer http.deinit();
// Load a previously obtained OAuth2 access token.
const json_token = try chilkat.JsonObject.init();
defer json_token.deinit();
json_token.loadFile("qa_data/tokens/docusign.json") catch {
std.debug.print("{s}\n", .{try json_token.getLastErrorText(alloc)});
return;
};
// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.setAuthToken(try json_token.stringOf(alloc, "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"
// }]
// }
// }
// ]
// }
const json = try chilkat.JsonObject.init();
defer json.deinit();
var i: i32 = 0;
json.setI(i);
json.updateString("carbonCopies[i].email", "support@chilkatsoft.com") catch {};
json.updateString("carbonCopies[i].name", "Chilkat Support") catch {};
json.updateString("carbonCopies[i].recipientId", "101") catch {};
json.updateNewObject("carbonCopies[i].tabs") catch {};
i = 0;
json.setI(i);
json.updateString("signers[i].email", "admin@chilkatsoft.com") catch {};
json.updateString("signers[i].name", "Chilkat Admin") catch {};
json.updateString("signers[i].recipientId", "1") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorString", "Please Sign Here") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorXOffset", "1") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorYOffset", "0") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", "false") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorUnits", "inches") catch {};
i = i + 1;
json.setI(i);
json.updateString("signers[i].email", "matt@chilkat.io") catch {};
json.updateString("signers[i].name", "Matt") catch {};
json.updateString("signers[i].recipientId", "2") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorString", "Please Also Sign Here") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorXOffset", "1") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorYOffset", "0") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", "false") catch {};
json.updateString("signers[i].tabs.signHereTabs[0].anchorUnits", "inches") catch {};
const sb_json = try chilkat.StringBuilder.init();
defer sb_json.deinit();
json.setEmitCompact(false);
json.emitSb(sb_json) catch {};
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") catch {};
// Use the envelope ID returned by DocuSign when creating the draft envelope).
http.setUrlVar("envelopeId", "cee4191c-f94e-4089-9d7c-8033685cbc1a") catch {};
const url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients";
const resp = try chilkat.HttpResponse.init();
defer resp.deinit();
http.httpSb("POST", url, sb_json, "utf-8", "application/json", resp) catch {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
};
const j_resp = try chilkat.JsonObject.init();
defer j_resp.deinit();
j_resp.load(try resp.getBodyStr(alloc)) catch {};
j_resp.setEmitCompact(false);
std.debug.print("Response Body:\n", .{});
std.debug.print("{s}\n", .{try j_resp.emit(alloc)});
// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
const resp_status_code = resp.getStatusCode();
std.debug.print("Response Status Code = {d}\n", .{resp_status_code});
if (resp_status_code >= 400) {
std.debug.print("Response Header:\n", .{});
std.debug.print("{s}\n", .{try resp.getHeader(alloc)});
std.debug.print("Failed.\n", .{});
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
var creation_reason: [:0]const u8 = "";
var require_upload_signature: [:0]const u8 = "";
var email: [:0]const u8 = "";
var recipient_id: [:0]const u8 = "";
var require_id_lookup: [:0]const u8 = "";
var routing_order: [:0]const u8 = "";
var status: [:0]const u8 = "";
var completed_count: [:0]const u8 = "";
var delivery_method: [:0]const u8 = "";
var recipient_type: [:0]const u8 = "";
_ = try json.stringOf(alloc, "recipientCount");
i = 0;
var count_i: i32 = json.sizeOfArray("signers");
while (i < count_i) {
json.setI(i);
creation_reason = try json.stringOf(alloc, "signers[i].creationReason");
require_upload_signature = try json.stringOf(alloc, "signers[i].requireUploadSignature");
email = try json.stringOf(alloc, "signers[i].email");
recipient_id = try json.stringOf(alloc, "signers[i].recipientId");
require_id_lookup = try json.stringOf(alloc, "signers[i].requireIdLookup");
routing_order = try json.stringOf(alloc, "signers[i].routingOrder");
status = try json.stringOf(alloc, "signers[i].status");
completed_count = try json.stringOf(alloc, "signers[i].completedCount");
delivery_method = try json.stringOf(alloc, "signers[i].deliveryMethod");
recipient_type = try json.stringOf(alloc, "signers[i].recipientType");
i = i + 1;
}
i = 0;
count_i = json.sizeOfArray("agents");
while (i < count_i) {
json.setI(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.sizeOfArray("editors");
while (i < count_i) {
json.setI(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.sizeOfArray("intermediaries");
while (i < count_i) {
json.setI(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.sizeOfArray("carbonCopies");
while (i < count_i) {
json.setI(i);
email = try json.stringOf(alloc, "carbonCopies[i].email");
recipient_id = try json.stringOf(alloc, "carbonCopies[i].recipientId");
require_id_lookup = try json.stringOf(alloc, "carbonCopies[i].requireIdLookup");
routing_order = try json.stringOf(alloc, "carbonCopies[i].routingOrder");
status = try json.stringOf(alloc, "carbonCopies[i].status");
completed_count = try json.stringOf(alloc, "carbonCopies[i].completedCount");
delivery_method = try json.stringOf(alloc, "carbonCopies[i].deliveryMethod");
recipient_type = try json.stringOf(alloc, "carbonCopies[i].recipientType");
i = i + 1;
}
i = 0;
count_i = json.sizeOfArray("certifiedDeliveries");
while (i < count_i) {
json.setI(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.sizeOfArray("inPersonSigners");
while (i < count_i) {
json.setI(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.sizeOfArray("seals");
while (i < count_i) {
json.setI(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.sizeOfArray("witnesses");
while (i < count_i) {
json.setI(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"
// }
//
}