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.
This endpoint allows you to update or change a suppression group.
Bearer <<YOUR_API_KEY_HERE>>Optional
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.
The ID of the suppression group you would like to retrieve.
application/jsonOptional
The name of your suppression group. Required when creating a group.
30Optional
A brief description of your suppression group. Required when creating a group.
100Optional
Indicates if you would like this to be your default suppression group.
The id of the suppression group.
The name of the suppression group. Each group created by a user must have a unique name.
30A description of the suppression group.
100Indicates if this is the default suppression group.
falseThe unsubscribes associated with this group.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const group_id = "ZGkrHSypTsudrGkmdpJJ";5const data = {6id: 103,7name: "Item Suggestions",8description: "Suggestions for items our users might like.",9};1011const request = {12url: `/v3/asm/groups/${group_id}`,13method: "PATCH",14body: data,15};1617client18.request(request)19.then(([response, body]) => {20console.log(response.statusCode);21console.log(response.body);22})23.catch((error) => {24console.error(error);25});