Send reminders

post/v1/document/remind

A 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("https://api.boldsign.com", "{your API key}");
var documentClient = new DocumentClient(apiClient);
documentClient.RemindDocument(
documentId: "8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c",
reminderMessage: new ReminderMessage(message: "Please sign this soon"));
import requests

url = "https://api.boldsign.com/v1/document/remind?documentId=8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c"

payload = "{ \"message\": \"Please sign this soon\", }"
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)
const axios = require('axios'); 
const response = await axios.post( 
    ' https://api.boldsign.com/v1/document/remind', 
    // '{\n  "message": "string",\n  "onBehalfOf": "string"\n}', 
    { 
        'message': 'string', 
        'onBehalfOf': 'string' 
    }, 
    { 
        params: { 
            'documentId': '{documentId}' 
        }, 
        headers: { 
            'accept': '*/*', 
            'X-API-KEY': '{your-api-key}', 
            'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true' 
        } 
    } 
); 

Query parameters

h1h2
documentIdstringRequiredThe ID of the document to which the reminder has to be sent.
receiverEmailsarrayMail ID of the signer. Multiple signer IDs can be specified if the signature is requested from multiple signers for the same document.

Request body

h1h2
messagearrayMessage to be sent to the signer to remind them.
onBehalfOfarrayMail ID of the sender if you are sending reminders to the on behalf of documents.

Example response

204 No Content