Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve a Bounce



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).


GET/v3/suppression/bounces/{email}

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 retrieve a specific bounce by email address.


Authentication

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

on-behalf-ofstring

Optional

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.

Property nameTypeRequiredDescription
emailstring<email>required

The email address of the specific bounce you would like to retrieve

200
SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties
creatednumber

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


emailstring<email>

The email address that was added to the bounce list.


reasonstring

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


statusstring

Enhanced SMTP bounce response

Retrieve a BounceLink to code sample: Retrieve a Bounce
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const email = "brian12@example.net";
5
6
const request = {
7
url: `/v3/suppression/bounces/${email}`,
8
method: "GET",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.