Skip to content
  1. Blog
  2. API

How to Control Recipient Notifications via BoldSign API

TL;DR: You choose which emails a signer gets by adding recipientNotificationSettings to that signer in your send request. Set each event, such as reminders or completed, to true or false. Leave the object out and your business profile defaults apply. Our eSignature API page shows what else you can build.

You send one client five contracts in a week. Each contract brings its own signing request, reminders and status updates. Soon the client gets so many emails that the important ones get lost.

You can fix that per signer. A client might get only the request to sign and the final completed copy, with no reminders in between. This guide explains each setting, then shows the code.

What are recipient notifications in BoldSign?

Recipient notifications are the emails we send a signer as a document moves along. They cover events such as a new signing request, a reminder, a decline or the completed document.

Think of a delivery app on your phone. You can ask for an alert when the parcel arrives and skip the alerts for every stop on the way. The recipientNotificationSettings property gives each signer the same kind of choice.

What happens when you leave the settings out?

Your business profile decides. Without recipientNotificationSettings in the request, each signer gets the notifications set there.

Those defaults cover reminders, signing requests and other events for every document you send. Add the property only when one signer should get something different.

Which recipient notifications can you turn on or off?

Each setting is a true or false value inside recipientNotificationSettings. Our send document API reference lists them, grouped here by what they report.

Notifications about signing progress

  • signatureRequest: the document is sent to the recipient.
  • signed: another recipient has signed the document.
  • completed: everyone has finished and the document is complete.
  • reminders: reminder emails for a signing request still waiting.

Notifications about problems and changes

  • declined: a recipient declined the document.
  • revoked: the sender revoked the document.
  • expired: the document passed its expiry date.
  • reassigned: the document went to a different signer.
  • deleted: the document was deleted.

Notifications about edits

Two settings report edits. editRecipient covers a change to a recipient on the document, and editDocument covers an edit to the document itself.

The samples below set the first ten settings. Add editDocument when signers should hear about document edits.

How do you set recipient notifications with the BoldSign API?

Add the property to a signer in your send request to the /v1/document/send endpoint. Our developer guide on how to customize recipient notifications covers the same steps.

  1. Build the signer with a name, email address and at least one form field.
  2. Add a recipientNotificationSettings object to that signer.
  3. Set each notification to true to send it, or false to skip it.
  4. Send the request with your API key in the X-API-KEY header.

The samples below turn every notification on. Change any value to false to switch that email off for this signer.

curl -X 'POST' \
  'https://api.boldsign.com/v1/document/send' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "Signers": [
    {
      "name": "Alex",
      "emailAddress": "alex@example.com",
      "signerType": "Signer",
      "formFields": [
        {
          "id": "string",
          "name": "string",
          "fieldType": "Signature",
          "pageNumber": 1,
          "bounds": {
            "x": 50,
            "y": 50,
            "width": 125,
            "height": 25
          },
          "isRequired": true
        }
      ],
      "recipientNotificationSettings": {
        "signatureRequest": true,
        "declined": true,
        "revoked": true,
        "signed": true,
        "completed": true,
        "expired": true,
        "reassigned": true,
        "deleted": true,
        "reminders": true,
        "editRecipient": true
      }
    }
  ],
  "Files": [
    "data:application/pdf;base64,JVBERi0xLjcKJcfs..."
  ],
  "Title": "Sampledocument"
}'
using BoldSign.Api;
using BoldSign.Model;

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

var documentFilePath = new DocumentFilePath
{
    ContentType = "application/pdf",
    FilePath = "agreement.pdf",
};

var filesToUpload = new List<IDocumentFile>
{
    documentFilePath,
};

var signatureField = new FormField(
    id: "sign",
    isRequired: true,
    type: FieldType.Signature,
    pageNumber: 1,
    bounds: new Rectangle(x: 100, y: 100, width: 100, height: 50));

var formFieldCollections = new List<FormField>()
{
    signatureField
};

var signer = new DocumentSigner(
    signerName: "Alex",
    signerType: SignerType.Signer,
    signerEmail: "alex@example.com",
    formFields: formFieldCollections);

signer.RecipientNotificationSettings = new RecipientNotificationSettings()
{
    SignatureRequest = true,
    Declined = true,
    Revoked = true,
    Signed= true,
    Completed= true,
    Expired = true,
    Reassigned = true,
    Deleted = true,
    Reminders = true,
    EditRecipient = true
};

var documentSigners = new List<DocumentSigner>()
{
    signer
};

var sendForSign = new SendForSign()
{
    Title = "Agreement",
    Signers = documentSigners,
    Files = filesToUpload
};
var documentCreated = documentClient.SendDocument(sendForSign);
import requests
import json

url = "https://api.boldsign.com/v1/document/send"

signer_data = {
    "name": "Alex",
    "emailAddress": "alex@example.com",
    "signerType": "Signer",
    "formFields": [
        {
            "id": "string",
            "name": "string",
            "fieldType": "Signature",
            "pageNumber": 1,
            "bounds": {"x": 50, "y": 50, "width": 200, "height": 25},
            "isRequired": True,
        }
    ],
    "recipientNotificationSettings": {
        "signatureRequest": True,
        "declined": True,
        "revoked": True,
        "signed": True,
        "completed": True,
        "expired": True,
        "reassigned": True,
        "deleted": True,
        "reminders": True,
        "editRecipient": True,
    },
}

payload = {
    "Signers": [signer_data],
    "Title": "Agreement",
    "Files": ["data:application/pdf;base64,JVBERi0xLjcKJcfs..."],
}

headers = {
    "Content-Type": "application/json",
    "accept": "application/json",
    "X-API-KEY": "{your API key}",
}

response = requests.post(url, headers=headers, json=payload)
print(response.text)
const axios = require("axios");
const fs = require("fs");

// Create the payload object
const payload = {
  Signers: [
    {
      name: "Alex",
      emailAddress: "alex@example.com",
      formFields: [
        {
          fieldType: "Signature",
          pageNumber: 1,
          bounds: {
            x: 100,
            y: 100,
            width: 100,
            height: 50,
          },
          isRequired: true,
        },
      ],
      recipientNotificationSettings: {
        signatureRequest: true,
        declined: true,
        revoked: true,
        signed: true,
        completed: true,
        expired: true,
        reassigned: true,
        deleted: true,
        reminders: true,
        editRecipient: true,
      },
    },
  ],
  Files: ["data:application/pdf;base64,JVBERi0xLjcKJcfs..."],
  Title: "Agreement",
};
async function sendDocument() {
  const response = await axios.post("https://api.boldsign.com/v1/document/send", payload, {
    headers: {
      "Content-Type": "application/json",
      "accept": "application/json",
      "X-API-KEY": "{your API key}",
    },
  });

  console.log(response.data);
}

sendDocument();
<?php
require_once "vendor/autoload.php";
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client();

$headers = [
    'accept' => 'application/json',
    'Content-Type' => 'application/json',
    'X-API-KEY' => '{your API key}'
];

$payload = [
    "Signers" => [
        [
            "name" => "Alex",
            "emailAddress" => "alex@example.com",
            "signerType" => "Signer",
            "formFields" => [
                [
                    "id" => "string",
                    "name" => "string",
                    "fieldType" => "Signature",
                    "pageNumber" => 1,
                    "bounds" => [
                        "x" => 50,
                        "y" => 50,
                        "width" => 125,
                        "height" => 25
                    ],
                    "isRequired" => true
                ]
            ],
            "recipientNotificationSettings" => [
                "signatureRequest" => true,
                "declined" => true,
                "revoked" => true,
                "signed" => true,
                "completed" => true,
                "expired" => true,
                "reassigned" => true,
                "deleted" => true,
                "reminders" => true,
                "editRecipient" => true
            ]
        ]
    ],
    "Files" => [
        'data:application/pdf;base64,JVBERi0xLjcKJcfs...'
    ],
    "Title" => 'Sample document'
];

$options = [
    'body' => json_encode($payload)
];

$request = new Request('POST', 'https://api.boldsign.com/v1/document/send', $headers);
$res = $client->sendAsync($request, $options)->wait();
echo $res->getBody();
When the request succeeds, we create the document and email the signer according to these settings.

How do you give two signers different notifications?

Give each signer their own recipientNotificationSettings object in the same request. One signer can get every email while the other gets none.

Our help article on controlling recipient notifications shows a full request with two signers. The first has every value set to true, and the second has every value set to false.

What should you check before you turn notifications off?

Test each change in the sandbox before you send to real signers. A missing email can leave a signer unaware that a document is waiting.

  • Keep signatureRequest on unless you share the signing link another way.
  • Turn off reminders only when you plan to follow up yourself.
  • Use DisableEmails in the request to stop emails for every recipient at once.

Want reminders on your own terms instead? See how to send a manual reminder via the API or set up automatic reminders with the API.

Which BoldSign API plan do you need, and what does it cost?

Live API requests need the Enterprise API plan, from $30 a month with 40 envelopes, as listed on the BoldSign pricing page in November 2026. Each extra envelope costs $0.75, and prices are in USD.

To build and test first, use the free sandbox. It needs no credit card, and its documents carry a test watermark and are deleted after 14 days.

Where do you go next with recipient notifications?

Pick one signer who gets too many emails today and try a lighter set of settings.

Frequently asked questions

What does recipientNotificationSettings do in the BoldSign API?

It sets which document emails one signer receives. You add it to that signer in the send request and mark each event, such as reminders or completed, true or false.

What happens if I leave out recipientNotificationSettings?

The signer gets the notifications set in your business profile. You only need the object when one signer should get something different from your usual defaults.

Can I turn off reminders for one signer only?

Yes. Set reminders to false in that signer's settings and leave it true for the others. Only that signer stops getting reminder emails for the pending request.

Can two signers on one document get different notifications?

Yes. Each signer carries their own settings object. One signer can get every email while another gets none, all in the same send request.

How do I stop all emails for a document?

Set DisableEmails to true in the send request. That turns off document emails for every recipient at once, so you do not need to change each signer.

What does the signed notification cover?

It tells a recipient that another recipient has signed the document. Turn it off when a signer only needs to hear about the final, completed document.

Is a document still legally binding if I turn off notifications?

Yes, when it meets the same rules as any other electronic signature. Notification settings only change which emails a recipient gets, so signing works the same way.

Can I test notification settings without paying?

Yes. A free API sandbox account lets you send test documents with these settings. Test documents carry a watermark and are deleted after 14 days.

Ranjitha Amirthalingam

Ranjitha is a seasoned developer with over 7 years of hands-on experience in C#, specializing in desktop applications using WPF and Blazor. Beyond the world of coding, Ranjitha has a passion for travel, particularly enjoying the tranquility and beauty of mountain ranges. Whether working on cutting-edge software or exploring nature, Ranjitha is always seeking new adventures and challenges. Connect with her on LinkedIn.

More posts by Ranjitha Amirthalingam
Get started

Sign up for your free trial today!

Start free trial
  • 30-day free trial
  • No credit card required