The BoldSign mobile app is now available. Visitthis link for more details and give it a try!

The BoldSign mobile app is now available. Visitthis link for more details and give it a try!

Request Demo
BoldSign Logo Small

Features

Explore the BoldSign features that make eSigning easier.

How to Send a Manual Reminder to Sign a Document via API

How to Send a Manual Reminder to Sign a Document via API

Ensuring that all parties promptly sign documents maintains workflow efficiency and helps you meet deadlines. Sometimes, a gentle reminder is necessary to prompt signers to complete their part. Sending manual reminders via API lets you manage this process efficiently. This blog will guide you through the steps to send a manual reminder to sign a document using the BoldSign API.

Importance of Manual Reminders

Manual reminders allow you to:

  • Control timing: Send reminders at strategic times.
  • Target specific recipients: Address signers who may require additional prompting.
  • Prompt action: Encourage signers to complete their signatures promptly.
  • Avoid delays: Help prevent workflow bottlenecks.
  • Maintain compliance: Ensure timely execution of legally binding documents.

BoldSign API Overview

BoldSign provides a comprehensive API that includes functionalities for sending reminders to signers. The POST /v1/document/remind endpoint is specifically designed for this purpose, allowing you to send reminder emails to all pending signers of a document.

Endpoint Details

Endpoint `POST /v1/document/remind`
Purpose Sends a manual reminder email to the signers of a specified document.
Query Parameters
  • `documentId` (STRING, REQUIRED): The ID of the document for which the reminder should be sent.
  • `receiverEmails` (ARRAY): Email address of the signer. Multiple email addresses can be specified if the document requires signatures from multiple signers.
Request Body
  • `message` (STRING, REQUIRED): The message to be included in the reminder email.
  • `onBehalfOf` (STRING, OPTIONAL): The email address of the sender if the document was sent on behalf of someone else.

Step-by-Step Guide to Sending Manual Reminders

Step 1: Gather Required Information

BoldSign provides an API that allows you to programmatically send a manual reminder to recipients of a document by providing the following details:

Document ID: The ID of the document for which you want to send a reminder.

Signer Email(s): The email addresses of the signers who need to be reminded.
Reminder Message: A personalized message to include in the reminder email.

So, you need to have these ready.

Step 2: Construct the API Request

Here’s how to construct the API request to send a manual reminder. Following are examples using different programming languages.

Curl

    
curl -X 'POST' \
  'https://api.boldsign.com/v1/document/remind?documentId={Your Document Id}&receiverEmails={1st signer email}&receiverEmails={2nd signer email}' \
  -H 'accept: */*' \
  -H 'X-API-KEY: {Your API Key}' \
  -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
  -d '{
  "message": "{Your message to the signers}"
}'
 

C#

    
var apiClient = new ApiClient("https://api.boldsign.com", "{Your API Key}");
        var documentClient = new DocumentClient(apiClient);
        documentClient.RemindDocument(
            documentId: "{Your Document Id}",
            receiverEmails: new List<string> { "{1st signer email}", "{2nd signer email}"},
            reminderMessage: new ReminderMessage(message: "{Your message to the signers}"));
 

Python

    
import requests
url = "https://api.boldsign.com/v1/document/remind?documentId={Your Document Id}}&receiverEmails={1st signer email}&receiverEmails={2nd signer email}"

payload = "{ \"message\": \"{Your message to the signers}\", }"
headers = {
  'accept': '*/*',
  'X-API-KEY': '{Your API Key}',
  'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
 

Node.js

    
const axios = require('axios'); 
const response = axios.post( 

    ' https://api.boldsign.com/v1/document/remind', 
    { 
        'message': '{Your message to the signers}',
    }, 

    { 
        params: { 
            'documentId': '{Your Document Id}', 
            'receiverEmails': ['{1st signer email}', '{2nd signer email}'],
        }, 
        headers: { 
            'accept': '*/*', 
            'X-API-KEY': '{Your API Key}', 
            'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true' 
        } 
    } 
);
 

PHP

    
<?php
require_once 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client(['verify' => false]);
$headers = [
    'accept' => '*/*',
    'X-API-KEY' => '{Your API Key}',
    'Content-Type' => 'application/json;odata.metadata=minimal;odata.streaming=true'
];
$body = json_encode([
    'message' => '{Your message to the signers}'
]);

$request = new Request('POST', 'https://api.boldsign.com/v1/document/remind?documentId={Your Document Id}&receiverEmails={1st signer email}&receiverEmails={2nd signer email}', $headers, $body);
$response = $client->sendAsync($request)->wait();
echo $response->getBody();
?>
 

Conclusion

Sending manual reminders for eSignatures on documents helps ensure timely completion and maintain workflow efficiency. By following the steps outlined in this blog, you can effectively send manual reminders to your signers and keep your document signing process on track.

If you’re not yet a customer, start a 30-day free trial to try out BoldSign’s features. Please feel free to leave a comment below; your thoughts are much appreciated. If you have any questions or would like more information about our services, please schedule a demo or contact our support team via our support portal.
Picture of Gopinath Kannusamy

Gopinath Kannusamy

Gopinath is a passionate software developer with 2 years of experience at BoldSign. He is an avid writer and enjoys sharing his insights on technology and development. In his free time, he enjoys exploring new technologies and learning new things.

Share this blog

Picture of Gopinath Kannusamy

Gopinath Kannusamy

Gopinath is a passionate software developer with 2 years of experience at BoldSign. He is an avid writer and enjoys sharing his insights on technology and development. In his free time, he enjoys exploring new technologies and learning new things.

Subscribe RSS feed

Leave a Reply

Your email address will not be published. Required fields are marked *