Rust
Rust
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 Rust Downloads
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = chilkat::Http::new();
// Load a previously obtained OAuth2 access token.
let json_token = chilkat::JsonObject::new();
if json_token.load_file("qa_data/tokens/docusign.json").is_err() {
println!("{}", json_token.last_error_text());
return;
}
// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.set_auth_token(&json_token.string_of("access_token").unwrap_or_default());
// 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 = chilkat::JsonObject::new();
let mut i = 0;
json.set_i(i);
let _ = json.update_string("carbonCopies[i].email", "support@chilkatsoft.com");
let _ = json.update_string("carbonCopies[i].name", "Chilkat Support");
let _ = json.update_string("carbonCopies[i].recipientId", "101");
let _ = json.update_new_object("carbonCopies[i].tabs");
i = 0;
json.set_i(i);
let _ = json.update_string("signers[i].email", "admin@chilkatsoft.com");
let _ = json.update_string("signers[i].name", "Chilkat Admin");
let _ = json.update_string("signers[i].recipientId", "1");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorString", "Please Sign Here");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorXOffset", "1");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorYOffset", "0");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", "false");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorUnits", "inches");
i = i + 1;
json.set_i(i);
let _ = json.update_string("signers[i].email", "matt@chilkat.io");
let _ = json.update_string("signers[i].name", "Matt");
let _ = json.update_string("signers[i].recipientId", "2");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorString", "Please Also Sign Here");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorXOffset", "1");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorYOffset", "0");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", "false");
let _ = json.update_string("signers[i].tabs.signHereTabs[0].anchorUnits", "inches");
let sb_json = chilkat::StringBuilder::new();
json.set_emit_compact(false);
let _ = json.emit_sb(&sb_json);
http.set_request_header("Cache-Control", "no-cache");
http.set_request_header("Accept", "application/json");
// Use your own account ID here.
let _ = http.set_url_var("accountId", "7f3f65ed-5e87-418d-94c1-92499ddc8252");
// Use the envelope ID returned by DocuSign when creating the draft envelope).
let _ = http.set_url_var("envelopeId", "cee4191c-f94e-4089-9d7c-8033685cbc1a");
let url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients".to_string();
let resp = chilkat::HttpResponse::new();
if http.http_sb("POST", &url, &sb_json, "utf-8", "application/json", &resp).is_err() {
println!("{}", http.last_error_text());
return;
}
let j_resp = chilkat::JsonObject::new();
let _ = j_resp.load(&resp.body_str());
j_resp.set_emit_compact(false);
println!("Response Body:");
println!("{}", j_resp.emit().unwrap_or_default());
// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
let resp_status_code = resp.status_code();
println!("Response Status Code = {}", resp_status_code);
if resp_status_code >= 400 {
println!("Response Header:");
println!("{}", resp.header());
println!("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
let recipient_count = json.string_of("recipientCount").unwrap_or_default();
i = 0;
let mut count_i = json.size_of_array("signers");
while i < count_i {
json.set_i(i);
let _ = json.string_of("signers[i].creationReason").unwrap_or_default();
let _ = json.string_of("signers[i].requireUploadSignature").unwrap_or_default();
let _ = json.string_of("signers[i].email").unwrap_or_default();
let _ = json.string_of("signers[i].recipientId").unwrap_or_default();
let _ = json.string_of("signers[i].requireIdLookup").unwrap_or_default();
let _ = json.string_of("signers[i].routingOrder").unwrap_or_default();
let _ = json.string_of("signers[i].status").unwrap_or_default();
let _ = json.string_of("signers[i].completedCount").unwrap_or_default();
let _ = json.string_of("signers[i].deliveryMethod").unwrap_or_default();
let _ = json.string_of("signers[i].recipientType").unwrap_or_default();
i = i + 1;
}
i = 0;
count_i = json.size_of_array("agents");
while i < count_i {
json.set_i(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.size_of_array("editors");
while i < count_i {
json.set_i(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.size_of_array("intermediaries");
while i < count_i {
json.set_i(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.size_of_array("carbonCopies");
while i < count_i {
json.set_i(i);
let _ = json.string_of("carbonCopies[i].email").unwrap_or_default();
let _ = json.string_of("carbonCopies[i].recipientId").unwrap_or_default();
let _ = json.string_of("carbonCopies[i].requireIdLookup").unwrap_or_default();
let _ = json.string_of("carbonCopies[i].routingOrder").unwrap_or_default();
let _ = json.string_of("carbonCopies[i].status").unwrap_or_default();
let _ = json.string_of("carbonCopies[i].completedCount").unwrap_or_default();
let _ = json.string_of("carbonCopies[i].deliveryMethod").unwrap_or_default();
let _ = json.string_of("carbonCopies[i].recipientType").unwrap_or_default();
i = i + 1;
}
i = 0;
count_i = json.size_of_array("certifiedDeliveries");
while i < count_i {
json.set_i(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.size_of_array("inPersonSigners");
while i < count_i {
json.set_i(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.size_of_array("seals");
while i < count_i {
json.set_i(i);
// ...
i = i + 1;
}
i = 0;
count_i = json.size_of_array("witnesses");
while i < count_i {
json.set_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"
// }
//