Suppressions - Suppressions
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.
Search for suppressions within a 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
- API Key
Headers
Request Body
The array of email addresses to add or find.
{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}
Path Parameters
The ID of the suppression group that you would like to search.
default: NoneResponses
The email address from your search that do exist in the suppression group.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.