Sending for signing
BoloForms BASE_URL to use https://sapi.boloforms.com/signature/pdf-template-lambda
Get the API key from Key Generation
Get the documentId
Prepare the JSON Body
You can batch upto 100 recipients in one request.
{
"signingType": "FORM_TEMPLATE", // "PDF_TEMPLATE" or "FORM_TEMPLATE"
"receiversList": [
{
"name": "Chirag Gupta", // name of the role
"email": "support@boloforms.com", // email of the role
"message": "Message me when you're done", // you can leave this empty it will take the message from emailData
"subject": "Please sign this Chirag" // you can leave this empty it will take the message from emailData
},
{
"name": "Chirag Gupta", // name of the role
"email": "support@boloforms.com", // email of the role
"message": "Message me when you're done",// you can leave this empty it will take the message from emailData
"subject": "Please sign this Paresh" // you can leave this empty it will take the message from emailData
}
],
"mailData": {
"subject": "subject",
// this is the global subject if you will not add anything in the receiversList
// subject this will be sent
"message": "message"
// this is the global message if you will not add anything in the receiversList
// message this will be sent
},
"documentId": "42d3b486-g946-4744-86cb-7ee25f634576"
}
"signingType": "PDF_TEMPLATE" or "FORM_TEMPLATE" which you want to send for signing
"receiversList": [
{
"name": "Chirag Gupta", // name of the role
"email": "support@boloforms.com", // email of the role
"message": "Message me when you're done", // you can leave this empty it will take the message from emailData
"subject": "Please sign this Chirag" // you can leave this empty it will take the message from emailData
},
],
"mailData": {
"subject": "subject",
// this is the global subject if you will not add anything in the receiversList
// subject this will be sent
"message": "message"
// this is the global message if you will not add anything in the receiversList
// message this will be sent
}
"documentId": is the document Id which you got from previous step
Send a POST request with the prepared JSON body
Example Request
const axios = require('axios');
let data = JSON.stringify({
"signingType": "FORM_TEMPLATE",
"receiversList": [
{
"name": "Chirag Gupta",
"email": "support@boloforms.com",
"message": "Message me when you're done",
"subject": "Please sign this Chirag"
},
{
"name": "Chirag Gupta",
"email": "support@boloforms.com",
"message": "Message me when you're done",
"subject": "Please sign this Paresh"
}
],
"mailData": {
"subject": "subject",
"message": "message"
},
"documentId": "YOUR_FORM_DOCUMENT_ID"
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://sapi.boloforms.com/signature/pdf-template-lambda',
headers: {
'x-api-key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
var myHeaders = new Headers();
myHeaders.append("x-api-key", "YOUR_API_KEY");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({
"signingType": "FORM_TEMPLATE",
"receiversList": [
{
"name": "Chirag Gupta",
"email": "support@boloforms.com",
"message": "Message me when you're done",
"subject": "Please sign this Chirag"
},
{
"name": "Chirag Gupta",
"email": "support@boloforms.com",
"message": "Message me when you're done",
"subject": "Please sign this Paresh"
}
],
"mailData": {
"subject": "subject",
"message": "message"
},
"documentId": "YOUR_FORM_DOCUMENT_ID"
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://sapi.boloforms.com/signature/pdf-template-lambda", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"signingType\": \"FORM_TEMPLATE\", \n \"receiversList\": [\r\n {\r\n \"name\": \"Chirag Gupta\", \n \"email\": \"support@boloforms.com\", \n \"message\": \"Message me when you're done\", \n \"subject\": \"Please sign this Chirag\" \n },\r\n {\r\n \"name\": \"Chirag Gupta\", \n \"email\": \"support@boloforms.com\", \n \"message\": \"Message me when you're done\", \n \"subject\": \"Please sign this Paresh\" \n }\r\n ],\r\n \"mailData\": {\r\n \"subject\": \"subject\",\r\n \n \n \"message\": \"message\"\r\n \n \n },\r\n \"documentId\": \"YOUR_FORM_DOCUMENT_ID\"\r\n}");
Request request = new Request.Builder()
.url("https://sapi.boloforms.com/signature/pdf-template-lambda")
.method("POST", body)
.addHeader("x-api-key", "YOUR_API_KEY")
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
<?php
$client = new Client();
$headers = [
'x-api-key' => 'YOUR_API_KEY',
'Content-Type' => 'application/json'
];
$body = '{
"signingType": "FORM_TEMPLATE",
"receiversList": [
{
"name": "Chirag Gupta",
"email": "support@boloforms.com",
"message": "Message me when you're done",
"subject": "Please sign this Chirag"
},
{
"name": "Chirag Gupta",
"email": "support@boloforms.com",
"message": "Message me when you're done",
"subject": "Please sign this Paresh"
}
],
"mailData": {
"subject": "subject",
"message": "message"
},
"documentId": "YOUR_FORM_DOCUMENT_ID"
}';
$request = new Request('POST', 'https://sapi.boloforms.com/signature/pdf-template-lambda', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
Last updated