Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve a specific invalid email



API Overview

api-overview page anchor

An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipient's mail server.

Examples include addresses without the "@" sign or addresses that include certain special characters and/or spaces. This response can come from our own server or the recipient mail server.

For more information, please see our Invalid Email documentation.


GET/v3/suppression/invalid_emails/{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 invalid email addresses.


Authentication

authentication page anchor
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.

Property nameTypeRequiredDescription
emailstringrequired

The specific email address of the invalid email entry that you want to retrieve.

200
SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties
createdinteger

A Unix timestamp indicating when the email address was added to the invalid emails list.


emailstring<email>

The email address that was marked as invalid.


reasonstring

The reason that the email address was marked as invalid.

Retrieve a specific invalid emailLink to code sample: Retrieve a specific invalid email
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const email = "annahamilton@example.org";
5
6
const request = {
7
url: `/v3/suppression/invalid_emails/${email}`,
8
method: 'GET',
9
10
}
11
12
client.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
});