How to Send Reminders for Pending Documents

If you've sent a document to a signer and they haven't completed the signing process yet, but you need to send them a reminder, BoldSign offers API support for sending reminders. This will trigger a reminder email to be sent to the signer, alerting them to complete the signing.

Here are example codes that you can use for sending reminders to sign a document:

Code snippet

curl -X 'POST' \ 'https://api.boldsign.com/v1/document/remind?documentId={documentId}' \
     -H 'accept: */*' \
     -H 'X-API-KEY: {your-api-key}'\
     -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
     -d '{
     "message": "string"
}'

var apiClient = new ApiClient("https://api.boldsign.com", "{your API key}");
var documentClient = new DocumentClient(apiClient);
documentClient.RemindDocument(
documentId: "{documentId}",
reminderMessage: new ReminderMessage(message: "Please sign this soon"));

import boldsign

configuration = boldsign.Configuration(host = "https://api.boldsign.com", api_key = "YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)

    reminder_message = boldsign.ReminderMessage(message = "Reminder message")

    document_api.remind_document(
        document_id = "YOUR_DOCUMENT_ID",
        receiver_emails = ["YOUR_RECEIVER_EMAIL"],
        reminder_message = reminder_message
    )

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

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\ReminderMessage;

$config = new Configuration();
$config->setHost("https://api.boldsign.com");
$config->setApiKey('YOUR_API_KEY');

$document_api = new DocumentApi($config);

$reminder_message = new ReminderMessage();
$reminder_message->setMessage('Reminder message');

$document_api->remindDocument($document_id = 'YOUR_DOCUMENT_ID', $receiver_emails = 'YOUR_RECEIVER_EMAIL', $reminder_message);

ApiClient client = Configuration.getDefaultApiClient();  
client.setBasePath("https://api.boldsign.com");
client.setApiKey("YOUR_API_KEY");

DocumentApi documentApi = new DocumentApi(client);

List<String> receiverEmails = Arrays.asList("[email protected]"); 
ReminderMessage reminderMessage = new ReminderMessage();
reminderMessage.setMessage("Reminder message");

documentApi.remindDocument("YOUR_DOCUMENT_ID", receiverEmails, reminderMessage);

import { DocumentApi, ReminderMessage } from "boldsign"; 

const documentApi = new DocumentApi("https://api.boldsign.com");
documentApi.setApiKey("YOUR_API_KEY");

const reminderMessage = new ReminderMessage();
reminderMessage.message = "Please sign this soon";

documentApi.remindDocument("YOUR_DOCUMENT_ID", ["[email protected]"], reminderMessage);

In the above examples, replace documentId with the ID of the document for which you want to send a reminder. Customize the message to tailor the reminder message you want to convey to the signer. Executing the provided commands will send a reminder email to the signer, containing the signing link. The signer can then click the link to complete the signing process.