Menu

Expand
Rate this page:

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 bounce purge mail settings

PATCH /v3/mail_settings/bounce_purge

Base url: https://api.sendgrid.com

This endpoint allows you to update your current bounce and purge settings.

The Bounce Perge setting allows you to set a schedule that Twilio SendGrid will use to automatically delete contacts from your soft and hard bounce suppression lists. The schedule is set in full days by assigning the number of days, an integer, to the soft_bounces and/or hard_bounces fields.

A hard bounce occurs when an email message has been returned to the sender because the recipient's address is invalid. A hard bounce might occur because the domain name doesn't exist or because the recipient is unknown.

A soft bounce occurs when an email message reaches the recipient's mail server but is bounced back undelivered before it actually reaches the recipient. A soft bounce might occur because the recipient's inbox is full.

You can also manage this setting in the Mail Settings section of the Twilio SendGrid App. You can manage your bounces manually using the Bounces API or the Bounces menu in the Twilio SendGrid App.

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 the bounce purge mail setting is enabled.

soft_bounces
integer or null

The number of days after which SendGrid will purge all contacts from your soft bounces suppression lists.

hard_bounces
integer or null

The number of days after which SendGrid will purge all contacts from your hard bounces suppression lists.

{
  "enabled": false,
  "soft_bounces": 1234,
  "hard_bounces": null
}

Responses

object
enabled
boolean

Indicates if the bounce purge mail setting is enabled.

soft_bounces
integer or null

The number of days after which SendGrid will purge all contacts from your soft bounces suppression lists.

hard_bounces
integer or null

The number of days after which SendGrid will purge all contacts from your hard bounces suppression lists.

{
  "enabled": false,
  "soft_bounces": 1234,
  "hard_bounces": null
}
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!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              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