How to send document from template with auto reminder using BoldSign API?

When creating a document in BoldSign, you can easily set up auto reminders. This feature allows you to specify the number of days between each reminder and the total number of reminders to be sent until the signer completes the signing process.The user can only change these configurations while creating the document, which cannot be changed after the document has been sent.

Follow these steps to send document from template with auto reminder:

Create a template in your account

In order to send a document from template, you first need to have a template created in your account. If you dont have one, follow this steps to create:

To create a template in the BoldSign web application, refer to the article Create Template.
To create a template using the API, follow the steps outlined in the article Create template through API.

Send the document with Auto reminder enabled

Once you have a template in your account, you can proceed to send out your document by providing the template Id of the created template in the query parameter section. To enable automatic reminders, use the ReminderSettings object when sending a document to signers. By setting EnableAutoReminder to true, you can specify the frequency of reminders after the initial reminder by adding days in the ReminderDays field and setting the total number of reminders in the ReminderCount field. You can configure up to 5 reminders.

Use the following codes to send document from template with autoreminder enabled:

Code snippet

curl -X 'POST' \ 'https://api.boldsign.com/v1/template/send?templateId={your template Id}' \
     -H 'accept: application/json' \
     -H 'X-API-KEY: {your API key}' \
     -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
     -d '{
       "title": "Invitation form",
       "message": "Kindly review and sign this.",
       "roles": [
    {
      "roleIndex": 1,
      "signerName": "Richard",
      "signerOrder": 1,
      "signerEmail": "starvritsa@boldsign.dev",
      "privateMessage": "Please check and sign the document.",
      "signerType": "Signer",
      "signerRole": "Manager",
     "formFields": [
    {
      "id": "SignField",
      "fieldType": "Signature",
      "pageNumber": 1,
      "bounds": {
        "x": 100,
        "y": 100,
        "width": 100,
        "height": 50
      },
      "isRequired": true
    },
  ],
      "locale": "EN"
    }
  ],
  "reminderSettings": {
    "enableAutoReminder": true,
    "reminderDays": 3,
    "reminderCount": 10
  }
 
  }`\

var apiClient = new ApiClient("https://api.boldsign.com", "{your API key}");

          var templateClient = new TemplateClient(apiClient);
          var signatureField = new FormField(
            id: "sign_id",
            type: FieldType.Signature,
            pageNumber: 1,
            bounds: new Rectangle(x: 100, y: 100, width: 100, height: 50));

          var formFieldsCollections = new List<FormField>
{
  signatureField,
};

          var templateRole = new Roles(
            roleSignerName: "David",
            roleSignerEmailAddress: "starvuritsabuhungi@boldsign.dev",
            roleSignerIndex: 1,
            formFields: formFieldsCollections,
            locale: Locales.EN);

          var roles = new List<Roles>
{
  templateRole,
};

          var sendForSignFromTemplate = new SendForSignFromTemplate()
          {
              TemplateId = "{your templateid}",
              Roles = roles,
              ReminderSettings= new ReminderSettings()
              { EnableAutoReminder = true,
                ReminderCount=3,
                ReminderDays=5,
              },
          };

          var documentCreated = templateClient.SendUsingTemplate(sendForSignFromTemplate);

import json
import requests

url = "https://api.boldsign.com/v1/template/send?templateId={your template id}"

payload = {
    "roles": [
        {
            "roleIndex": 1,
            "signerName": "David",
            "signerEmail": "starvritsabuhungi@boldsign.dev",
            "formFields": [
                {
                    "fieldType": "Signature",
                    "pageNumber": 1,
                    "bounds": {
                        "x": 100,
                        "y": 100,
                        "width": 100,
                        "height": 50
                    }
                }
            ]
        }
    ],
    "ReminderSettings.EnableAutoReminder": "true",
    "ReminderSettings.ReminderDays": "4",
    "ReminderSettings.ReminderCount": "3"
}

headers = {
    'accept': 'application/json',
    'X-API-KEY': '{your api key}',
    'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.text)

const axios = require('axios');

async function sendTemplate() {
    try {
        const response = await axios.post(
            'https://api.boldsign.com/v1/template/send',
            {
                'roles': [
                    {
                        'roleIndex': 1,
                        'signerName': 'David',
                        'signerEmail': 'starvritsabuhungi@syncfusion.com',
                        'formFields': [
                            {
                                'fieldType': 'Signature',
                                'pageNumber': 1,
                                'bounds': {
                                    'x': 100,
                                    'y': 100,
                                    'width': 100,
                                    'height': 50
                                }
                            }
                        ]
                    }
                ],
                'ReminderSettings': {
                    'EnableAutoReminder': true,
                    'ReminderDays': 4,
                    'ReminderCount': 3
                }
            },
            {
                params: {
                    'templateId': '{your template id}}'
                },
                headers: {
                    'accept': 'application/json',
                    'X-API-KEY': '{your api key}}',
                    'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
                }
            }
        );
        console.log(response.data);
    } catch (error) {
        console.error(error.response.data);
    }
}

sendTemplate();

In the provided code example, replace templateId with the ID of the existing template to be used for sending the document and ensure that EnableAutoReminder is set to true. Additionally, configure the ReminderDays and ReminderCount properties to suit your needs. Upon executing the provided code, a document will be generated with the auto reminders at specified intervals and a specified number of times until the document is signed.

With these steps, you can successfully send a document from template with autoreminder settings enabled.