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.
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.
- API Key
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 unsubscribe group that you are adding suppressions to.default: None
The list of email addresses belonging to the given suppression group.