Menu

Expand

This documentation is for the SendGrid Web API v2

To access all the latest features and upcoming developments, please see our v3 API.

Rate this page:

Invalid Emails

This endpoint allows you to retrieve and delete entries in the Invalid Emails list.

Get

Retrieve a list of invalid emails with addresses and response codes, optionally with dates.

URI Parameter Required Requirements Description
date No Must be set to 1 Retrieve the timestamp of the invalid email records. It will return a date in a MySQL timestamp format - YYYY-MM-DD HH:MM:SS
days No If specified, must be an integer greater than 0 Number of days in the past for which to retrieve invalid emails (includes today)
start_date No Date must be in YYYY-MM-DD format and be earlier than the end_date parameter. The start of the date range for which to retrieve invalid emails.
end_date No Date must be in YYYY-MM-DD format and be later than the start_date parameter. The end of the date range for which to retrieve invalid emails.
limit No Some integer Optional field to limit the number of results returned.
offset No Some integer Optional beginning point in the list to retrieve from.
email No Email address eg testing@example.com Optional email addresses to search for.

Call

GET https://api.sendgrid.com/api/invalidemails.get.json
GET Data api_user=apikey&api_key=your_sendgrid_api_key&date=1

Response

[
  {
    "reason": "Known bad domain",
    "created": "2011-06-06 16:11:57",
    "email": "test@example.com"
  },
  {
    "reason": "Invalid address",
    "created": "2012-08-17 11:04:38",
    "email": "brandon"
  }
]

Call

GET https://api.sendgrid.com/api/invalidemails.get.xml
GET Data api_user=apikey&api_key=your_sendgrid_api_key&date=1

Response

<invalidemails>
   <invalidemail>
      <reason>Known bad domain</reason>
      <created>2011-06-06 16:11:57</created>
      <email>test@example.com</email>
   </invalidemail>
   <invalidemail>
      <reason>Invalid address</reason>
      <created>2012-08-17 11:04:38</created>
      <email>brandon</email>
   </invalidemail>
</invalidemails>

Count

Retrieve the count of invalid emails.

URI Parameter Required Requirements Description
start_date No Date must be in YYYY-MM-DD format and be earlier than the end_date parameter. The start of the date range for which to retrieve invalid emails.
end_date No Date must be in YYYY-MM-DD format and be later than the start_date parameter. The end of the date range for which to retrieve invalid emails.

Call

GET https://api.sendgrid.com/api/invalidemails.count.json
GET Data api_user=apikey&api_key=your_sendgrid_api_key

Response

{
  "count": 2
}

Call

GET https://api.sendgrid.com/api/invalidemails.count.xml
GET Data api_user=apikey&api_key=your_sendgrid_api_key

Response

<result>
   <count>2</count>
   <result> </result>
</result>

Delete

Delete an address from the Invalid Email list.

URI Parameter Required Requirements Description
email Yes Must be a valid user account email Email Invalid Email address to remove

Call

POST https://api.sendgrid.com/api/invalidemails.delete.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=emailToDelete@domain.com

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/invalidemails.delete.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=emailToDelete@domain.com

Response

<result>
   success
   <result> </result>
</result>
Rate this page:
        
        
        

        Thank you for your feedback!

        We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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

        Thanks for your feedback!

        Refer us and get $10 in 3 simple steps!

        Step 1

        Get link

        Get a free personal referral link here

        Step 2

        Give $10

        Your user signs up and upgrade using link

        Step 3

        Get $10

        1,250 free SMSes
        OR 1,000 free voice mins
        OR 12,000 chats
        OR more