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

Search for suppressions within a group



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.


POST/v3/asm/groups/{group_id}/suppressions/search

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

This endpoint allows you to search a suppression group for multiple suppressions.

When given a list of email addresses and a group ID, this endpoint will only return the email addresses that have been unsubscribed from the given group.


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.

group_idstringrequired

The ID of the suppression group that you would like to search.

SchemaExample
recipient_emailsarray[string<email>]required

The array of email addresses to add or find.

200
SchemaExample
array[string<email>]

The email address from your search that do exist in the suppression group.

Search for suppressions within a group

search-for-suppressions-within-a-group page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_25
const client = require('@sendgrid/client');
_25
client.setApiKey(process.env.SENDGRID_API_KEY);
_25
_25
const group_id = "ZGkrHSypTsudrGkmdpJJ";
_25
const data = {
_25
"recipient_emails": [
_25
"test1@example.com",
_25
"test2@example.com"
_25
]
_25
};
_25
_25
const request = {
_25
url: `/v3/asm/groups/${group_id}/suppressions/search`,
_25
method: 'POST',
_25
body: data
_25
}
_25
_25
client.request(request)
_25
.then(([response, body]) => {
_25
console.log(response.statusCode);
_25
console.log(response.body);
_25
})
_25
.catch(error => {
_25
console.error(error);
_25
});


Rate this page: