Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Get information on a single suppression group.



API Overview

api-overview page anchor

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.


GET/v3/asm/groups/{group_id}

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve a single suppression group.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

group_idstringrequired

The ID of the suppression group you would like to retrieve.

200
SchemaExample
namestring

The name of your suppression group. Required when creating a group.

Max length: 30

descriptionstring

A brief description of your suppression group. Required when creating a group.

Max length: 100

is_defaultboolean

Indicates if you would like this to be your default suppression group.


idinteger

The ID of the suppression group.


unsubscribesinteger

The number of unsubscribes, or suppressions, in this group.


last_email_sent_atstring or null

Get information on a single suppression group.

get-information-on-a-single-suppression-group page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_19
const client = require('@sendgrid/client');
_19
client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19
const group_id = "ZGkrHSypTsudrGkmdpJJ";
_19
_19
const request = {
_19
url: `/v3/asm/groups/${group_id}`,
_19
method: 'GET',
_19
_19
}
_19
_19
client.request(request)
_19
.then(([response, body]) => {
_19
console.log(response.statusCode);
_19
console.log(response.body);
_19
})
_19
.catch(error => {
_19
console.error(error);
_19
});


Rate this page: