Delete invalid emails

API Overview

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.

Operation overview

DELETE/v3/suppression/invalid_emails

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 remove email addresses from your invalid email address list.

There are two options for deleting invalid email addresses:

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

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

delete_allboolean

Optional

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.

Responses

204

No response body.

Delete invalid emails

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