Send reminders
post/v1/document/remindA reminder is helpful when you need to remind your signers to sign the document. A reminder email will be sent to the signer. You can send reminders to multiple signers together if more than one signer is needed to sign the same 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", "onBehalfOf": "string" }'
var apiClient = new ApiClient("YOUR_API_KEY"); var documentClient = new DocumentClient(apiClient); documentClient.RemindDocument( documentId: "YOUR_DOCUMENT_ID", reminderMessage: new ReminderMessage(message: "Please sign this soon"));
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="Please sign this soon") document_api.remind_document(document_id="YOUR_DOCUMENT_ID", 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('Please sign this soon'); $document_api->remindDocument($document_id = 'YOUR_DOCUMENT_ID', $receiver_emails = ['david@cubeflakes.com'], $reminder_message);
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); DocumentApi documentApi = new DocumentApi(client); ReminderMessage reminderMessage = new ReminderMessage(); reminderMessage.setMessage("Please sign this soon"); documentApi.remindDocument( "YOUR_DOCUMENT_ID", null, reminderMessage);
import { DocumentApi, ReminderMessage } from "boldsign"; const documentApi = new DocumentApi(); documentApi.setApiKey("YOUR_API_KEY"); const reminderMessage = new ReminderMessage(); reminderMessage.message = "Please sign this soon"; documentApi.remindDocument("YOUR_DOCUMENT_ID", ["david@cubeflakes.com"], reminderMessage);
Query parameters
documentIdstringRequired | The ID of the document to which the reminder has to be sent. |
receiverEmailsarray | Mail ID of the signer. Multiple signer IDs can be specified if the signature is requested from multiple signers for the same document. |
Request body
messagearray | Message to be sent to the signer to remind them. |
onBehalfOfarray | Mail ID of the sender if you are sending reminders to the on behalf of documents. |
Example response
204 No Content