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:

Subuser Invalid Emails

Retrieve Invalid Emails

URI Parameter Required Requirements Description
task Yes Must be set to get Task to retrieve the invalid emails for the specified subuser
user Yes Subuser must be under your account The subuser retrieving invalid emails from
date No 0 or 1 Optional argument to retrieve the timestamps, in ISO-8601 format, Pacific Timezone: YYYY-MM-DD HH:MM:SS

Call

POST https://api.sendgrid.com/apiv2/customer.invalidemails.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=get&date=1

Response

[
  {
    "email": "example@example.com",
    "reason": "Mail domain mentioned in email address is unknown",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "isaac@hotmail",
    "reason": "Bad Syntax",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "example@example.com",
    "reason": "Known bad domain",
    "created": "2009-06-01 19:41:39"
  }
]

Call

POST https://api.sendgrid.com/apiv2/customer.invalidemails.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=get&date=1

Response

<invalidemails>
   <invalidemail>
      <email>example@example.com</email>
      <reason>Mail domain mentioned in email address is unknown</reason>
      <created>2009-06-10 12:40:30</created>
   </invalidemail>
   <invalidemail>
      <email>isaac@hotmail</email>
      <reason>Bad Syntax</reason>
      <created>2009-06-10 12:40:30</created>
   </invalidemail>
   <invalidemail>
      <email>example@example.com</email>
      <reason>Known bad domain</reason>
      <created>2009-06-10 12:40:30</created>
   </invalidemail>
</invalidemails>

Delete Invalid Emails

SendGrid drops messages to invalid emails. Users can remove invalid emails from their list at any time if they believe the address to now be valid.

URI Parameter Required Requirements Description
task Yes Must be set to delete Task to remove the specified email from the invalid email list for the specified subuser
user Yes Subuser must be under your account The subuser to retrieve invalid emails from
email Yes Must be a string You must specify the invalid emails to remove

Call

POST https://api.sendgrid.com/apiv2/customer.invalidemails.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=delete&email=invalidemail@example.com

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.invalidemails.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=delete&email=invalidemail@example.com

Response

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

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

      
      
      

      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