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.
Retrieve all suppression groups for an email address
GET /v3/asm/suppressions/{email}
Base url: https://api.sendgrid.com
This endpoint returns a list of all groups from which the given email address has been unsubscribed.
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.
Path Parameters
The email address that you want to search suppression groups for.
default: NoneResponses
The array of suppression groups.
The description of the suppression group.
The id of the suppression group.
Indicates if the suppression group is set as the default.
The name of the suppression group.
Indicates if the given email address is suppressed for this 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.
