On this page

Delete spam reports

API Overview

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.

Operation overview

DELETE/v3/suppression/spam_reports

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to delete your spam reports.

Deleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our bypass filters to deliver messages to otherwise suppressed addresses when exceptions are required.

There are two options for deleting spam reports:

You can delete all spam reports by setting the delete_all field to true in the request body.
You can delete a list of select spam reports by specifying the email addresses in the emails array of the request body.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

delete_allbooleanOptional

Indicates if you want to delete all email addresses on the spam report list.

emailsarray[string]Optional

A list of specific email addresses that you want to remove from the spam report list.

Responses

204

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete spam reports

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  "delete_all": false,
6  "emails": [
7    "example1@example.com",
8    "example2@example.com"
9  ]
10};
11
12const request = {
13  url: `/v3/suppression/spam_reports`,
14  method: 'DELETE',
15  body: data
16}
17
18client.request(request)
19  .then(([response, body]) => {
20    console.log(response.statusCode);
21    console.log(response.body);
22  })
23  .catch(error => {
24    console.error(error);
25  });