Articles in this section
Category / Section

Disable email notifications in all supported places

Published:

BoldSign allows API users to disable email notifications sent to signers and recipients during document workflows. By default, BoldSign sends emails when documents are shared, signed, completed, or when reminders are triggered. For automation-heavy or embedded workflows(Embedded Signing API), these emails may be unnecessary. By using the DisableEmails flag in supported API requests, you can prevent BoldSign from sending these notification emails while allowing the document workflow to continue normally. This is especially useful when your application already handles user communication or when documents are signed entirely within an embedded experience.

What Happens When DisableEmails Is Enabled?

When you set DisableEmails=true in an API request:

  • BoldSign does not send email notifications to signers or recipients
  • The document workflow proceeds as usual
  • Signing, completion, and audit tracking continue to work normally
  • All actions remain visible in BoldSign for compliance and record-keeping

Which Emails Are Disabled?

When DisableEmails=true, BoldSign does not send the following emails:

  • Emails sent when a document is shared for signing
  • Emails sent when a document is signed, declined, or completed
  • Automatic reminder emails for pending signatures
  • Emails triggered as part of embedded signing or template-based workflows

These emails are part of BoldSign’s default notification behavior and are automatically triggered during the document lifecycle.

Which Emails Are Still Sent?

The following emails are not affected by DisableEmails:

  • Manual reminders explicitly triggered by the sender through the API or the BoldSign UI

Note: DisableEmails only controls BoldSign’s automatic notification emails. Any reminders or messages you trigger manually will still be delivered.

Supported APIs for Disabling Email Notifications

You can disable email notifications using the DisableEmails flag in the following APIs:

Action Method Endpoint Typical Use Case
Send document POST /v1/document/send Send a document silently without email notifications
Send document from template POST /v1/template/send Send a template-based document without emails
Send document using multiple templates POST /v1/template/mergeAndSend Send merged templates silently
Create embedded request link POST /v1/document/createEmbeddedRequestUrl Generate embedded signing links without emails
Create embedded request link from template POST /v1/template/createEmbeddedRequestUrl Embed a template-based signing flow without emails
Create embedded request link using multiple templates POST /v1/template/mergeCreateEmbeddedRequestUrl Merge templates into a silent embedded workflow

How to Disable Emails in an API Request

To disable email notifications, include the DisableEmails flag in the request payload. The placement of the flag depends on the API type.

Example: Send a Document Without Email Notifications
curl -X 'POST' \
  'https://api.boldsign.com/v1/document/send' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {YOUR API KEY}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'message=sign' \
  -F 'signers={
  "name": "star",
  "emailAddress": "alexgayle@cubeflakes.com",
  "privateMessage": "sign",
  "authenticationType": "None",
  "deliveryMode": "Email",
  "signerType": "Signer",
  "allowFieldConfiguration": true,
  "formFields": [
    {
      "id": "sign",
      "name": "string",
      "fieldType": "Signature",
      "pageNumber": 1,
      "bounds": {
        "x": 130,
        "y": 130,
        "width": 81,
        "height": 31
      },
      "isRequired": true
    }
  ],
  "locale": "EN"
  
}' \
  -F 'DisableEmails=true' \
  -F 'Files=@{your file}' \
  -F 'title=Testing file name' 
Example: Send a Document from a Template Without Emails
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": 2,
      	"SignerName": "Richard",
      	"SignerOrder": 1,
      	"SignerEmail": "richard@cubeflakes.com",
      	"PrivateMessage": "Please check and sign the document.",
      	"AuthenticationCode": "281028",
      	"EnableEmailOTP": false,
      	"SignerType": "Signer",
      	"SignerRole": "Manager",
     	"FormFields": [
    	{
      	"Id": "SignField",
      	"FieldType": "Signature",
      	"PageNumber": 1,
      	"Bounds": {
        	"X": 100,
        	"Y": 100,
        	"Width": 100,
        	"Height": 50
      	},
      	"IsRequired": true
    	}
  	],
      	"Locale": "EN"
    	}
  	],
  	"DisableEmails": true
  	}'
Example : Send Document using Multiple Templates Without Emails
curl -X 'POST' \ 'https://api.boldsign.com/v1/template/mergeAndSend' \
     -H 'accept: application/json' \
     -H 'X-API-KEY: {your API key}' \
     -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
     -d '{
       "TemplateIds": [
          "1a62a39c-xxxx-xxxx-xxxx-c0a09ee3fc82", "01c19aef-xxxx-xxxx-xxxx-7178ef2e1036"
        ],
       "Title": "Invitation form",
       "Message": "Kindly review and sign this.",
       "Roles": [
    {
      "RoleIndex": 50,
      "SignerName": "Richard",
      "SignerOrder": 1,
      "SignerEmail": "richard@cubeflakes.com",
      "SignerType": "Signer",
      "SignerRole": "Manager",
     "FormFields": [
    {
      "Id": "SignField",
      "FieldType": "Signature",
      "PageNumber": 1,
      "Bounds": {
        "X": 100,
        "Y": 100,
        "Width": 100,
        "Height": 50
      },
      "IsRequired": true
    }
  ],
      "Locale": "EN"
    }
  ],
  "DisableEmails": true
  }'
Example : Create embedded request link Without Emails
curl -X POST 'https://api.boldsign.com/v1/document/createEmbeddedRequestUrl' \
    -H 'accept: application/json' \
    -H 'X-API-KEY: {your API key}' \
    -F 'Title=Sent from API Curl' \
    -F 'ShowToolbar=true' \
    -F 'ShowNavigationButtons=true' \
    -F 'ShowPreviewButton=true' \
    -F 'ShowSendButton=true' \
    -F 'ShowSaveButton=true' \
    -F 'SendViewOption=PreparePage' \
    -F 'ShowTooltip=false' \
    -F 'Message=This is document message sent from API Curl' \
    -F 'Signers[0][Name]=Signer Name 1' \
    -F 'Signers[0][EmailAddress]=alexgayle@cubeflakes.com' \
    -F 'Signers[0][SignerOrder]=1' \
    -F 'Signers[0][FormFields][0][FieldType]=Signature' \
    -F 'Signers[0][FormFields][0][Id]=Sign' \
    -F 'Signers[0][FormFields][0][PageNumber]=1' \
    -F 'Signers[0][FormFields][0][IsRequired]=True' \
    -F 'Signers[0][FormFields][0][Bounds][X]=50' \
    -F 'Signers[0][FormFields][0][Bounds][Y]=50' \
    -F 'Signers[0][FormFields][0][Bounds][Width]=200' \
    -F 'Signers[0][FormFields][0][Bounds][Height]=30' \
    -F 'Files=@{your file}'
    -F "DisableEmails=true"
Example : Create embedded request link from template Without Emails
curl -X POST 'https://api.boldsign.com/v1/template/createEmbeddedRequestUrl?templateId=<template-id>' \
    -H 'X-API-KEY: <api-key>' \
    -H 'Content-Type: application/json' \
    -d '{
        "ShowToolbar": true,
        "SendViewOption": "FillingPage",
        "ShowSaveButton": true,
        "ShowSendButton": true,
        "Locale": "EN",
        "ShowPreviewButton": true,
        "ShowNavigationButtons": true,
        "ShowTooltip": false,
        "DisableEmails": true
    }'
Create embedded request link using multiple templates
curl -X POST 'https://api.boldsign.com/v1/template/mergeCreateEmbeddedRequestUrl' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json' \
  -d '{
      "ShowToolbar": true,
      "SendViewOption": "FillingPage",
      "ShowSaveButton": true,
      "ShowSendButton": true,
      "ShowPreviewButton": true,
      "ShowNavigationButtons": true,
      "ShowTooltip": false,
      "DisableEmails": true,
      "TemplateIds": [
        "b6e722a9-xxxx-xxxx-xxxx-ad3e3f95f5fa","516e056b-xxxx-xxxx-xxx-9ae90ed3217f"
      ]
  }'

In the above example, the document is sent silently without triggering any email notifications. By setting the DisableEmails=true flag in the request payload, recipients will not receive system-generated alerts. Once the request is executed, the document workflow continues quietly, while all actions remain tracked internally through BoldSign. For implementation details, refer to the Send Document API.

Important Notes
  • DisableEmails is false by default
  • If the flag is not provided, email notifications will be sent
  • This setting only affects automatic emails sent by BoldSign
  • Manual reminders are never suppressed
  • Disabling emails does not affect signing, completion, or audit logs
When Should You Disable Email Notifications?

You should use DisableEmails when:

  • Documents are signed through embedded workflows
  • Your application manages its own user notifications
  • You want silent backend or scheduled document processing
  • You are running high-volume or white-label integrations

Summary

The DisableEmails flag gives API users precise control over email notifications in BoldSign. By disabling automatic emails, you can build quiet, embedded, and automation-friendly signing workflows while maintaining full document tracking and compliance.

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
Access denied
Access denied