On this page

Create a new suppression group

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

POST/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 create a new suppression group.

To add an email address to the suppression group, create a Suppression.

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.

Request body

Encoding type:application/json

Schema

Property nameTypeRequiredDescriptionChild properties

namestring

Optional

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

Max length: 30

descriptionstring

Optional

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

Max length: 100

is_defaultboolean

Optional

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

Responses

201

SchemaExample

Property nameTypeRequiredDescriptionChild properties

idinteger

The ID of the suppression group.

namestring

The name of the suppression group.

descriptionstring

A brief description of the suppression group.

is_defaultboolean

Indicates if this is the default suppression group.

Create a new suppression group

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const request = {
5  url: `/v3/asm/groups`,
6  method: "POST",
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  });