TL;DR: Call
POST /v1/document/remindwith the document ID, and we email a reminder to the signers who have not finished. AddreceiverEmailsto remind only some of them, and amessageto say why. Our eSignature API page shows what else you can build.
A lease went out on Monday and two of three tenants have signed. The move-in date is Friday, and the third tenant has not opened the email.
You could wait for the next automatic reminder. Or your app can send a manual reminder now, with a short note about the deadline. This guide shows how to do that with one API call.
What is a manual reminder to sign a document?
A manual reminder is an email you trigger on demand to signers who have not completed a document. Your app decides when it goes out, instead of a fixed schedule.
Think of a friend who owes you a reply about dinner plans. A calendar alert pings them on a schedule, but sometimes you just send a quick text when the table needs booking.
The reminder does not sign for anyone. Each signer must still open the document and manually sign it.
When can you send a manual reminder?
You can send one to documents in the Waiting or In Progress status. Only signers who have not yet completed their part receive it.
We allow one manual reminder per document each day. A manual reminder leaves your automatic reminder settings as they are. Our developer guide on sending reminders for waiting or in progress documents covers the same rules.
How does the remind endpoint work?
The endpoint is POST /v1/document/remind, and it emails a reminder to the pending signers of one document. On success, it returns 204 No Content.
Which parameters does it take?
documentId(required, query string): the ID of the document to remind signers aboutreceiverEmails(optional, query string): the signer addresses to remind, repeated for each signermessage(optional, request body): the text we add to the reminder emailonBehalfOf(optional, request body): the sender’s email, for documents sent on behalf of someone else
Leave out receiverEmails, and we remind every pending signer on the document. The full list is in the send reminder API reference.
How do manual and automatic reminders differ?
Manual reminders go out on demand after you send the document. Automatic reminders run on a schedule you set while creating the document.
Use a manual reminder to follow up at a set moment, or to nudge selected signers. Automatic reminders suit standard, repeated workflows, and you can set defaults for your whole organization.
Our guide to setting up automatic reminders with the API walks through the settings. The developer guide on reminding signers automatically during document creation has the full reference.
How do you send a manual reminder with the BoldSign API?
You need three details and one request. The steps below take you from finding the signers to sending the email.
Step 1: Gather the document details
Have these ready before you call the endpoint:
- The document ID of the document you want to follow up
- The email address of each signer you want to remind
- A short reminder message, such as the deadline
The Document Properties API returns the signer emails and the current status. Call GET /v1/document/properties before the reminder request.
Step 2: Send the reminder request
Each sample below sends a reminder to two signers with a custom message. Pick the tab for your language and replace the placeholder values.
curl -X 'POST' \
'https://api.boldsign.com/v1/document/remind?documentId={YOUR_DOCUMENT_ID}&receiverEmails={first.signer@example.com}&receiverEmails={second.signer@example.com}' \
-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}"
}'
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> { "first.signer@example.com", "second.signer@example.com" },
reminderMessage: new ReminderMessage(message: "Your message to the signers"));
import boldsign
configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
document_api = boldsign.DocumentApi(api_client)
reminder_message = boldsign.ReminderMessage(message="Your message to the signers")
document_api.remind_document(
document_id="YOUR_DOCUMENT_ID",
receiver_emails=["first.signer@example.com", "second.signer@example.com"],
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->setApiKey('YOUR_API_KEY');
$document_api = new DocumentApi($config);
$reminder_message = new ReminderMessage();
$reminder_message->setMessage('Your message to the signers');
$receiver_emails = [
'first.signer@example.com',
'second.signer@example.com'
];
$document_api->remindDocument($document_id = 'YOUR_DOCUMENT_ID',
$receiver_emails, $reminder_message);
?>
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
DocumentApi documentApi = new DocumentApi(client);
List receiverEmails = Arrays.asList("first.signer@example.com", "second.signer@example.com");
ReminderMessage reminderMessage = new ReminderMessage();
reminderMessage.setMessage("Your message to the signers");
documentApi.remindDocument("YOUR_DOCUMENT_ID", receiverEmails, reminderMessage);
import { DocumentApi, ReminderMessage } from "boldsign";
async function main() {
const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");
const reminderMessage = new ReminderMessage();
reminderMessage.message = "Your message to the signers";
const receiverEmails = ["first.signer@example.com", "second.signer@example.com"];
await documentApi.remindDocument("YOUR_DOCUMENT_ID", receiverEmails, reminderMessage);
}
main();
Want to try the call without writing code first? Use the Postman Send Reminder request in our public workspace.
What should you watch out for?
Most failed reminders come from timing or the wrong address. Check these before you add the call to your app.
- A second manual reminder on the same day will not go out, so time the first one well.
- Each address in
receiverEmailsmust belong to a signer on that document. - Completed, declined, revoked and expired documents are not in the Waiting or In Progress status.
Prefer to work in the web app? Follow our support guide to send manual reminders from the dashboard.
Which plan do you need, and what does it cost?
You can build and test with the free API sandbox, which needs no credit card. Sandbox documents carry a “This is a test document” watermark, and we delete them after 14 days.
Live API access comes with the Enterprise API plan. It starts at $30 a month with 40 envelopes, and each extra envelope costs $0.75. See the BoldSign pricing page for current prices in USD.
Where do you go next with signing reminders?
Send a reminder on a test document first, then decide when your app should call it.
- Create a free API sandbox account and remind a test signer.
- Book a demo to talk through your integration with our team.
- Ask a question through our support portal.
Frequently asked questions
How do I remind clients to sign documents without manual follow-ups?
Turn on automatic reminders when you create the document, and we email pending signers on the schedule you set. Keep the remind endpoint for the odd case where a signer needs a nudge right now.
Which endpoint sends a manual signing reminder?
Call the /v1/document/remind endpoint with the document ID in the query string. A successful call returns 204 No Content.
Can I remind just one signer instead of everyone?
Yes. Add that signer's address in receiverEmails, and only they get the email. Leave the parameter out to remind every pending signer.
How many manual reminders can I send for one document?
You can send one manual reminder per document each day. Plan the timing, because a second call on the same day will not go out.
Does a manual reminder change my automatic reminder schedule?
No. Automatic reminders keep running on the schedule you set when you created the document.
Can I add my own message to the reminder email?
Yes. Put your text in the message field of the request body, and it appears in the email the signer receives.
How do I find the signer emails for a document?
Call the Document Properties API with the document ID. It returns each signer's email address and the current status of the document.
Can I test the remind endpoint for free?
Yes. Our free API sandbox needs no credit card. Sandbox documents carry a test watermark, and we delete them after 14 days.