Menu

Expand
Rate this page:

Invalid E-Mails API

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.

Retrieve all invalid emails

GET /v3/suppression/invalid_emails

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

This endpoint allows you to retrieve a list of all invalid email addresses.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string

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.

default: None

Query String

start_time
integer

Refers start of the time range in unix timestamp when an invalid email was created (inclusive).

default: None
end_time
integer

Refers end of the time range in unix timestamp when an invalid email was created (inclusive).

default: None
limit
integer

Limit the number of results to be displayed per page.

default: None
offset
integer

Paging offset. The point in the list to begin displaying results.

default: None
email
string

This parameter allows you to filter results by email address. Only invalid addresses matching an address passed in this parameter will be returned.

default: None

Responses

array[object]

The list of invalid email addresses.

created
integer

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

email
string

The email address that was marked as invalid.

format: email
reason
string

The reason that the email address was marked as invalid.

Loading Code Sample...
        
        
        

        Retrieve all invalid emails

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif