Menu

Expand
Rate this page:

Spam Reports API

Spam Reports are triggered when a recipient marks one of your emails as spam. Spam reports can only be gathered from Internet Service Providers (ISPs) that provide a feedback loop.

It is important that addresses that have marked your messages as spam be permanently removed from your send list, even if the recipients have previously opted into receiving your messages. Continuing to send to customers who have reported your email as spam can severely affect your deliverability rating.

You can also access your Spam Reports from the Suppressions settings menu in the Twilio SendGrid App.

For more information, please see our Spam Reports documentation.

Retrieve all spam reports

GET /v3/suppression/spam_reports

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve all spam reports.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

default: None

Query String

start_time
integer

The start of the time range when a spam report was created (inclusive). This is a unix timestamp.

default: None
end_time
integer

The end of the time range when a spam report was created (inclusive). This is a unix timestamp.

default: None
limit
integer

Limit the number of results to be displayed per page.

default: None
offset
integer

Paging offset. The point in the list to begin displaying results.

default: None

Responses

array[object]
created
integer

A Unix timestamp that indicates when the recipient marked your message as spam.

required
email
string

The email address of the recipient that marked your message as spam.

format: email
required
ip
string

The IP address that the message was sent from.

required
[
  {
    "created": 1443651141,
    "email": "user1@example.com",
    "ip": "10.63.202.100"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com",
    "ip": "10.63.202.100"
  }
]
Loading Code Sample...
        
        

        Retrieve all spam reports

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif