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 25 different suppression groups.
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve a single suppression group.
- API Key
The ID of the suppression group you would like to retrieve.default: None
The name of your suppression group. Required when creating a group.maxLength: 30
A brief description of your suppression group. Required when creating a group.maxLength: 100
Indicates if you would like this to be your default suppression group.
The ID of the suppression group.
The number of unsubscribes, or suppressions, in this group.