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

Retrieve all suppression groups for an email address



API Overview

api-overview page anchor

Suppressions are recipient email addresses that are added to unsubscribe groups. Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.


GET/v3/asm/suppressions/{email}

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

This endpoint returns a list of all groups from which the given email address has been unsubscribed.


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.

emailstringrequired

The email address that you want to search suppression groups for.

200
SchemaExample
suppressionsarray[object]

The array of suppression groups.

Retrieve all suppression groups for an email address

retrieve-all-suppression-groups-for-an-email-address 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 = "annahamilton@example.org";
_19
_19
const request = {
_19
url: `/v3/asm/suppressions/${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: