A suppression group, or an unsubscribe group, is a specific type of email from which your recipients can unsubscribe. For example, daily newsletter and system alerts can be suppression groups. Manage your suppression groups using Twilio Sendgrid API. You can also specify suppression groups by using an X-SMTPAPI header.
Make sure that the names and descriptions of your suppression groups are recipient-friendly. Recipients can view these names and descriptions when managing their email subscriptions.
You can create and retrieve up to 200 suppression groups for a Twilio Sendgrid account.
This endpoint allows you to retrieve a single 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.
The name of your suppression group. Required when creating a group.
30A brief description of your suppression group. Required when creating a group.
100Indicates 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.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const group_id = "ZGkrHSypTsudrGkmdpJJ";56const request = {7url: `/v3/asm/groups/${group_id}`,8method: "GET",9};1011client12.request(request)13.then(([response, body]) => {14console.log(response.statusCode);15console.log(response.body);16})17.catch((error) => {18console.error(error);19});