About Enforced TLS Settings

Overview

The Enforced TLS settings specify whether or not the recipient of an email is required to support TLS or have a valid certificate. For additional information on TLS required for users connecting to Twilio SendGrid to send emails we have this resource.

The Enforced TLS endpoint supports retrieving and updating TLS settings. Enforced TLS is an account-wide setting that will be applied to all emails sent through the account.

Note:, the recipient must support TLS 1.1 or higher or have a valid certificate. If these conditions are not met, we drop the message and send a block event with “TLS required but not supported” as the description.

 

What You Need To Know

GET

Get the current Enforced TLS settings.

 

Request URL

GET https://api.sendgrid.com/v3/user/settings/enforced_tls HTTP/1.1

 

Response

HTTP/1.1 200
{
    "require_tls": true,
    "require_valid_cert": false,
    "version": 1.1
}

 

PATCH

Change the Enforced TLS settings

URI Parameter Required Requirements Description
require_tls False true or false Require recipient TLS support
require_valid_cert False true or false Require certificates to be valid
version False 1.1, 1.2, 1.3 The minimum required TLS certificate version.

 

Request URL

PATCH https://api.sendgrid.com/v3/user/settings/enforced_tls HTTP/1.1

 

Request Body

{
  "require_tls": true
}

 

Response

HTTP/1.1 200
{
    "require_tls": true,
    "require_valid_cert": false,
    "version": 1.1
}
Have more questions? Submit a request