On this page

Delete bounces

API Overview

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.

Operation overview

DELETE/v3/suppression/bounces

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

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_all to true in the request body.
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.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

delete_allbooleanOptional

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

emailsarray[string]Optional

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

Responses

204401

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete bounces

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  "delete_all": false
6};
7
8const request = {
9  url: `/v3/suppression/bounces`,
10  method: 'DELETE',
11  body: data
12}
13
14client.request(request)
15  .then(([response, body]) => {
16    console.log(response.statusCode);
17    console.log(response.body);
18  })
19  .catch(error => {
20    console.error(error);
21  });