Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Delete bounces



API Overview

api-overview page anchor

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(link takes you to an external page).


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:

  1. You can delete all bounced emails by setting delete_all to true in the request body.
  2. You can delete a selection of bounced emails by specifying the email addresses in the emails array of the request body.

WARNING: You can not have both emails and delete_all set.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

SchemaExample
delete_allboolean

This parameter allows you to delete every email in your bounce list. This should not be used with the emails parameter.


emailsarray[string]

Delete multiple emails from your bounce list at the same time. This should not be used with the delete_all parameter.

204401
Schema

No properties defined

Delete bounces

delete-bounces page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_21
const client = require('@sendgrid/client');
_21
client.setApiKey(process.env.SENDGRID_API_KEY);
_21
_21
const data = {
_21
"delete_all": false
_21
};
_21
_21
const request = {
_21
url: `/v3/suppression/bounces`,
_21
method: 'DELETE',
_21
body: data
_21
}
_21
_21
client.request(request)
_21
.then(([response, body]) => {
_21
console.log(response.statusCode);
_21
console.log(response.body);
_21
})
_21
.catch(error => {
_21
console.error(error);
_21
});


Rate this page: