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.
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.
Bearer <<YOUR_API_KEY_HERE>>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.
The ID of the suppression group that you would like to search.
application/jsonThe array of email addresses to add or find.
array[string<email>]The email address from your search that do exist in the suppression group.
1const client = require('@sendgrid/client');2client.setApiKey(process.env.SENDGRID_API_KEY);34const group_id = "ZGkrHSypTsudrGkmdpJJ";5const data = {6"recipient_emails": [7"test1@example.com",8"test2@example.com"9]10};1112const request = {13url: `/v3/asm/groups/${group_id}/suppressions/search`,14method: 'POST',15body: data16}1718client.request(request)19.then(([response, body]) => {20console.log(response.statusCode);21console.log(response.body);22})23.catch(error => {24console.error(error);25});