Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Retrieve a specific spam report



API Overview

api-overview page anchor

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(link takes you to an external page).

For more information, please see our Spam Reports documentation.


GET/v3/suppression/spam_reports/{email}

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

This endpoint allows you to retrieve a specific spam report by email address.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

emailstring<email>required

The email address of a specific spam report that you want to retrieve.

200
SchemaExample

Array of:

createdinteger

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


emailstring<email>

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


ipstring

The IP address that the message was sent from.

Retrieve a specific spam report

retrieve-a-specific-spam-report page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_19
const client = require('@sendgrid/client');
_19
client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19
const email = "brian12@example.net";
_19
_19
const request = {
_19
url: `/v3/suppression/spam_reports/${email}`,
_19
method: 'GET',
_19
_19
}
_19
_19
client.request(request)
_19
.then(([response, body]) => {
_19
console.log(response.statusCode);
_19
console.log(response.body);
_19
})
_19
.catch(error => {
_19
console.error(error);
_19
});


Rate this page: