Menu

Expand
Rate this page:

Bounces API

An email is considered bounced when the message is undeliverable and then returned to the server that sent it. Bounced emails can be either permanent or temporary failures to deliver the message.

For more information, see our Bounces documentation.

You can also manage bounced emails from the Suppression settings menu in the Twilio SendGrid App.

Retrieve all bounces

GET /v3/suppression/bounces

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

This endpoint allows you to retrieve all of your bounces. A maximum of 500 bounces will be returned per query. You can use the offset and limit parameters to retrieve more or less than 500 results.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
Accept
string
default: application/json
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.

Query String

start_time
integer

Refers start of the time range in unix timestamp when a bounce was created (inclusive).

default: None
end_time
integer

Refers end of the time range in unix timestamp when a bounce was created (inclusive).

default: None
limit
integer

Limit the number of results to be displayed per page.

default: None
offset
integer

The point in the list to begin displaying results. To retrieve more than 500 results, you can make multiple requests to the API, using the offset to begin at the next result in the list.

default: None

Responses

array[object]
created
number

The unix timestamp for when the bounce record was created at SendGrid.

email
string

The email address that was added to the bounce list.

format: email
reason
string

The reason for the bounce. This typically will be a bounce code, an enhanced code, and a description.

status
string

Enhanced SMTP bounce response

object
errors
array[object]
message
string

the error message

field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
        
        
        
        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

              
              
              

              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