How to enable or disable notifications for specific signers in a multi-signer document using the BoldSign API

When sending documents through the BoldSign API, you have the flexibility to tailor the notification experience for each recipient using the recipientNotificationSettings property within your API request. This feature allows you to define how and when each signer is notified, giving you greater control over the signing workflow.

If you choose not to specify this property, BoldSign will automatically apply the default notification preferences set in your business profile.

By configuring recipientNotificationSettings, you can fine-tune the communication each recipient receives whether it’s enabling or disabling alerts for events like signing, declining, or reminders based on your specific use case or recipient preferences.

This article walks you through how to implement these settings effectively using a practical example with two signers: one with notifications enabled and the other with notifications disabled.

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": "alexgayle@boldsign.dev",
            "signerType": "Signer",
            "formFields": [
                {
                    "id": "field1",
                    "name": "SignatureField1",
                    "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
            }
        },
        {
            "name": "Jordan",
            "emailAddress": "jordanlee@boldsign.dev",
            "signerType": "Signer",
            "formFields": [
                {
                    "id": "field2",
                    "name": "SignatureField2",
                    "fieldType": "Signature",
                    "pageNumber": 1,
                    "bounds": {
                        "x": 50,
                        "y": 150,
                        "width": 125,
                        "height": 25
                    },
                    "isRequired": true
                }
            ],
            "recipientNotificationSettings": {
                "signatureRequest": false,
                "declined": false,
                "revoked": false,
                "signed": false,
                "completed": false,
                "expired": false,
                "reassigned": false,
                "deleted": false,
                "reminders": false,
                "editRecipient": false
            }
        }
    ],
    "Files": [
        "data:application/pdf;base64,JVBERi0xLjcKJcfs..."
    ],
    "Title": "Sampledocument"
  }'

By using this approach, you can ensure that each recipient receives only the notifications that are relevant to them, helping streamline communication and improve the overall signing experience.