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.
Delete bounces
DELETE /v3/suppression/bounces
Base url: https://api.sendgrid.com
This endpoint allows you to delete all emails on your bounces list.
There are two options for deleting bounced emails:
- You can delete all bounced emails by setting
delete_alltotruein the request body. - You can delete a selection of bounced emails by specifying the email addresses in the
emailsarray of the request body.
WARNING: You can not have both emails and delete_all set.
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.
Request Body
This parameter allows you to delete every email in your bounce list. This should not be used with the emails parameter.
Delete multiple emails from your bounce list at the same time. This should not be used with the delete_all parameter.
{
"delete_all": false
}Responses
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.
