Skip to contentSkip to navigationSkip to topbar
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 (for global users and subusers)

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

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
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.

Property nameTypeRequiredDescription
group_idstringrequired

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

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
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 groupLink to code sample: Search for suppressions within a group
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const group_id = "ZGkrHSypTsudrGkmdpJJ";
5
const data = {
6
recipient_emails: ["test1@example.com", "test2@example.com"],
7
};
8
9
const request = {
10
url: `/v3/asm/groups/${group_id}/suppressions/search`,
11
method: "POST",
12
body: data,
13
};
14
15
client
16
.request(request)
17
.then(([response, body]) => {
18
console.log(response.statusCode);
19
console.log(response.body);
20
})
21
.catch((error) => {
22
console.error(error);
23
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.