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.

Customer Subuser Bounces

Manage your Customer Subusers' Bounce records.

Retrieve Bounces

URI Parameter Required Requirements Description
user Yes Customer subuser must be registered under your account The customer subuser we are retrieving bounces from
task Yes Must be set to get This will allow you to retrieve the bounces for the specified customer subuser
date No Must be set to 1 Retrieves the timestamps. It will return a date in a MySQL timestamp format - YYYY-MM-DD HH:MM:SS
method Yes Must be set to bounces Allows you to access bounces functionality

Call

POST https://api.sendgrid.com/apiv2/reseller.subuserManage.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=bounces&user=example@example.com&task=get&date=1

Response

[
  {
    "email": "emaieexampexample@example.com",
    "status": "5.1.1",
    "reason": "host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: emaieexampexample@example.com",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "emaileexampexample@example.com",
    "status": "5.1.1",
    "reason": "host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: emaileexampexample@example.com",
    "created": "2009-06-01 19:41:39"
  }
]

Call

POST https://api.sendgrid.com/apiv2/reseller.subuserManage.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=bounces&user=example@example.com&task=get&date=1

Response

<bounces>
   <bounce>
      <email>emaieexampexample@example.com</email>
      <status>5.1.1</status>
      <reason>host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: emaieexampexample@example.com</reason>
      <created>2009-06-10 12:40:30</created>
   </bounce>
   <bounce>
      <email>emaileexampexample@example.com</email>
      <status>5.1.1</status>
      <reason>host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: emaileexampexample@example.com</reason>
      <created>2009-06-10 12:40:30</created>
   </bounce>
</bounces>

Delete Bounces

Since SendGrid does not re-deliver to bounced addresses, users can remove bounces from their list at any time if redelivery to a bounced address is desired.

URI Parameter Required Requirements Description
user Yes Subuser must be registered under your account The subuser we are retrieving bounces from
task Yes Must be set to delete This will allow you to delete the bounces for the specified user
email No Bounce email address you want to delete You must specify the bounced email message to remove
method Yes Must be set to bounces Allows you to access bounces functionality

Call

POST https://api.sendgrid.com/apiv2/reseller.subuserManage.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=bounces&user=example@example.com&task=delete&email=bounceexampexample@example.com

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/reseller.subuserManage.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=bounces&user=example@example.com&task=delete&email=bounceexampexample@example.com

Response

<result>
   <message>success</message>
</result>

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.