Menu

Settings - Mail

Mail Settings instruct SendGrid to apply specific settings to every email that you send over SendGrid’s v3 API or SMTP Relay. These settings include how to embed a custom footer, how to manage blocks, spam, and bounces, and more.

For a full list of Twilio SendGrid's Mail Settings, and what each one does, see our Mail Settings documentation.

You can also manage your Mail Settings in the Twilio SendGrid App

Update address whitelist mail settings

Update address whitelist mail settings

PATCH /mail_settings/address_whitelist

This endpoint allows you to update your current email address whitelist settings.

You can select whether or not this setting should be enabled by assigning the enabled field a true or false value.

Passing only the enabled field to this endpoint will not alter your current list of whitelist entries. However, any modifications to your list of entries will overwrite the entire list. For this reason, you must included all existing entries you wish to retain in your list in addition to any new entries you intend to add. To remove one or more list entries, pass a list with only the entries you wish to retain.

You should not add generic domains such as gmail.com or yahoo.com in your list because your emails will not honor recipients' unsubscribes. This may cause a legal violation of CAN-SPAM and could damage your sending reputation.

The Address Whitelist setting allows you to specify email addresses or domains for which mail should never be suppressed.

For example, if you own the domain example.com, and one or more of your recipients use email@example.com addresses, placing example.com in the address whitelist setting instructs Twilio SendGrid to ignore all bounces, blocks, and unsubscribes logged for that domain. In other words, all bounces, blocks, and unsubscribes will still be sent to example.com as if they were sent under normal sending conditions.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Request Body

object
enabled
boolean

Indicates if your email address whitelist is enabled.

list
array[string]

Either a single email address that you want whitelisted or a domain, for which all email addresses belonging to this domain will be whitelisted.

{
  "enabled": true,
  "list": [
    "email1@example.com",
    "example.com"
  ]
}

Responses

object
enabled
boolean

Indicates if you have an email address whitelist enabled.

list
array[string]

All email addresses that are currently on the whitelist.

{
  "enabled": true,
  "list": [
    "email1@example.com",
    "example.com"
  ]
}
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

parameter
string
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

parameter
string
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

parameter
string
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

parameter
string
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

parameter
string
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more