Retrieve Bounces

Parameter Required Requirements Description
task Yes Must be set to get Task to retrieve bounces
user Yes Subuser must be under your account Subuser to retrieve bounces of
date No 0 or 1 Optional argument to retrieve the timestamps, in ISO-8601 format, Pacific Timezone: YYYY-MM-DD HH:MM:SS
Parameter Value Requirements Description

Call

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

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
  {
    "email": "email1@domain.com",
    "status": "5.1.1",
    "reason": "550 5.1.1 unknown or illegal user: email1@domain.com",
    "created": "2014-12-06 08:34:48"
  },
  {
    "email": "email2@domain2.com",
    "status": "5.1.1",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at http:\/\/support.google.com\/mail\/bin\/answer.py?answer=6596 qy3si50924603pab.12 - gsmtp ",
    "created": "2014-12-06 08:36:34"
  }
]

Call

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

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<bounces>
   <bounce>
      <email>email1@domain.com</email>
      <status>5.1.1</status>
      <reason>550 5.1.1 unknown or illegal user: email1@domain.com</reason>
      <created>2014-12-06 08:34:48</created>
   </bounce>
   <bounce>
      <email>email2@domain2.com</email>
      <status>5.1.1</status>
      <reason>550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at http:\/\/support.google.com\/mail\/bin\/answer.py?answer=6596 qy3si50924603pab.12 - gsmtp </reason>
      <created>2014-12-06 08:36:34</created>
   </bounce>
</bounces>

Delete Bounces

SendGrid suppresses messages to bounced addresses, but entries can be removed from the suppression list at any time if redelivery to a bounced address is desired. Take care that the address should be redelivered to.

Parameter Required Requirements Description
task Yes Must be set to delete Task to remove address from bounce suppression list
user Yes Subuser must be under your account Subuser to retrieve bounces of
email Yes Address exists on the list Address to remove from the Bounce suppression list
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/user.bounces.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=delete&email=bounce@example.com

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/user.bounces.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=delete&email=bounce@example.com

Response

1
2
3
<result>
   <message>success</message>
</result>