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
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.
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. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
