Suppression groups, or unsubscribe groups, are specific types or categories of emails from which you would like your recipients to be able to unsubscribe. For example: Daily Newsletters, Invoices, and System Alerts are all potential suppression groups. Visit the main documentation to learn more about suppression/unsubscribe groups. You can also find more information about specifying unsubscribe groups when using the SMTP API in our X-SMTPAPI Header documentation.
The name and description of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
Each Twilio SendGrid account can create up to 200 different suppression groups.
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve a list of all suppression groups created by this user.
This endpoint can also return information for multiple group IDs that you include in your request. To add a group ID to your request, simply append
?id=123456&id=123456, with the appropriate group IDs.
- 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 suppression group.
The name of the suppression group. Each group created by a user must have a unique name.maxLength: 30
A description of the suppression group.maxLength: 100
Indicates if this is the default suppression group.default: False
The unsubscribes associated with this group.