Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: develop
Fetching contributors…

Cannot retrieve contributors at this time

88 lines (73 sloc) 3.04 kb
layout weight title navigation
page
0
Customer Bounces
show
true

{% anchor h2 %} Retrieve Bounces {% endanchor %}

{% parameters get %} {% parameter 'user' 'Yes' 'Customer must be registered under your account' 'The customer we are retrieving bounces from' %} {% parameter 'task' 'Yes' 'Must be set to get' 'This will allow you to retrieve the bounces for the specified customer' %} {% parameter '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' %} {% parameter 'method' 'Yes' 'Must be set to bounces' 'Allows you to access bounces functionality' %} {% endparameters %}

{% apiexample get POST https://api.sendgrid.com/apiv2/reseller.manage api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=bounces&user=customer@example.com&task=get&date=1 %} {% response json %} [ { "email": "email1@domain.com", "status": "5.1.1", "reason": "host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email1@domain.com", "created": "2009-06-01 19:41:39" }, { "email": "email2@domain2.com", "status": "5.1.1", "reason": "host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email2@domain2.com", "created": "2009-06-01 19:41:39" } ] {% endresponse %} {% response xml %} email1@domain.com 5.1.1 host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email1@domain.com 2009-06-10 12:40:30 email2@domain2.com 5.1.1 host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email2@domain2.com 2009-06-10 12:40:30

{% endresponse %} {% endapiexample %}


{% anchor h2 %} Delete Bounces {% endanchor %}

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.

{% parameters delete %} {% parameter 'user' 'Yes' 'Subuser must be registered under your account' 'The subuser we are retrieving bounces from' %} {% parameter 'task' 'Yes' 'Must be set to delete' 'This will allow you to delete the bounces for the specified user' %} {% parameter 'email' 'Yes' 'Bounce email address you want to delete' 'You must specify the bounced email message to remove' %} {% parameter 'method' 'Yes' 'Must be set to bounces' 'Allows you to access bounces functionality' %} {% endparameters %}

{% apiexample delete POST https://api.sendgrid.com/apiv2/reseller.manage api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=bounces&user=customer@example.com&task=delete&email=bounce@example.com %} {% response json %} { "message": "success" } {% endresponse %} {% response xml %} success

{% endresponse %} {% endapiexample %}

Jump to Line
Something went wrong with that request. Please try again.