Suppressions - Unsubscribe Groups
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
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.
Update a suppression group.
PATCH /v3/asm/groups/{group_id}
Base url: https://api.sendgrid.com
This endpoint allows you to update or change a suppression group.
Authentication
- API Key
Headers
Request Body
The name of your suppression group. Required when creating a group.
maxLength: 30A brief description of your suppression group. Required when creating a group.
maxLength: 100Indicates if you would like this to be your default suppression group.
{
"id": 103,
"name": "Item Suggestions",
"description": "Suggestions for items our users might like."
}Path Parameters
The ID of the suppression group you would like to retrieve.
default: NoneResponses
The id of the suppression group.
The name of the suppression group. Each group created by a user must have a unique name.
maxLength: 30A description of the suppression group.
maxLength: 100Indicates if this is the default suppression group.
default: FalseThe unsubscribes associated with this group.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.