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

Delete invalid emails



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.


DELETE/v3/suppression/invalid_emails

Base url: https://api.sendgrid.com

This endpoint allows you to remove email addresses from your invalid email address list.

There are two options for deleting invalid email addresses:

  1. You can delete all invalid email addresses by setting delete_all to true in the request body.
  2. You can delete some invalid email addresses by specifying certain addresses in an array in the request body.

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.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
delete_allbooleanOptional

Indicates if you want to remove all email address from the invalid emails list.


emailsarray[string<email>]Optional

The list of specific email addresses that you want to remove.

204
Schema
Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete invalid emails

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

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


Rate this page: