On this page

Retrieve all suppression groups associated with an account

API overview

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.

Operation overview

GET/v3/asm/groups

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to retrieve a list of all suppression groups created by this user.

This endpoint can also return information for multiple group IDs that you include in your request. To add a group ID to your request, simply append ?id=123456&id=123456, with the appropriate group IDs.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

Query string

Property nameTypeRequiredDescription

idinteger

Optional

The ID of the suppression group(s) you want to retrieve.

Responses

200

SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties

idnumber

The id of the suppression group.

namestring

The name of the suppression group. Each group created by a user must have a unique name.

Max length: 30

descriptionstring

A description of the suppression group.

Max length: 100

is_defaultboolean

Indicates if this is the default suppression group.

Default: false

unsubscribesinteger

The unsubscribes associated with this group.

Retrieve all suppression groups associated with the user.

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const request = {
5  url: `/v3/asm/groups`,
6  method: "GET",
7};
8
9client
10  .request(request)
11  .then(([response, body]) => {
12    console.log(response.statusCode);
13    console.log(response.body);
14  })
15  .catch((error) => {
16    console.error(error);
17  });