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
The on-behalf-of
header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>
). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>
). See On Behalf Of for more information.
Query String
Refers start of the time range in unix timestamp when a bounce was created (inclusive).
default: NoneRefers end of the time range in unix timestamp when a bounce was created (inclusive).
default: NoneLimit the number of results to be displayed per page.
default: NoneThe 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.
Responses
The unix timestamp for when the bounce record was created at SendGrid.
The email address that was added to the bounce list.
format: emailThe reason for the bounce. This typically will be a bounce code, an enhanced code, and a description.
Enhanced SMTP bounce response
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}
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.