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 Spam Reports

Manage your customers' spam reports.

Retrieve Spam Reports

URI Parameter Required Requirements Description
user Yes Customer must be registered under your account The customer we are retrieving spam reports from
task Yes Must be set to get This will allow you to retrieve the spam reports for the specified user
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 spamreports Allows you to access spam reports functionality

These are Reseller only APIs. For more information, see Reseller Overview.

Call

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

Response

[
  {
    "email": "emaieexampexample@example.com",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "emaileexampexample@example.com",
    "created": "2009-06-01 19:41:39"
  }
]

Call

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

Response

<spamreports>
   <spamreport>
      <email>emaieexampexample@example.com</email>
      <created>2009-06-10 12:40:30</created>
   </spamreport>
   <spamreport>
      <email>emaileexampexample@example.com</email>
      <created>2009-06-10 12:40:30</created>
   </spamreport>
</spamreports>

Delete Spam Reports

Since SendGrid does not deliver to spam reported addresses, users can remove spam reports from their list at any time if re-delivery to a spam reported address is desired.

URI Parameter Required Requirements Description
user Yes Customer must be registered under your account The customer we are retrieving spam reports from
task Yes Must be set to delete This will allow you to delete a spam report for the specified user
email Yes Must be a spam report You must specify the spam reports to remove
method Yes Must be set to spamreports Allows you to access spam reports functionality

Call

POST https://api.sendgrid.com/apiv2/reseller.manage.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=spamreports&user=eexampexample@example.com&task=delete&email=spamreport@domain.com

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/reseller.manage.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=spamreports&user=eexampexample@example.com&task=delete&email=spamreport@domain.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.