Menu

Suppressions - Unsubscribe Groups

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

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 25 different suppression groups.

Create a new suppression group

Create a new suppression group

POST /asm/groups

This endpoint allows you to create a new suppression group.

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

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Request Body

object
name
string

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

maxLength: 30
description
string

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

maxLength: 100
is_default
boolean

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

Responses

object
id
integer

The ID of the suppression group.

required
name
string

The name of the suppression group.

required
description
string

A brief description of the suppression group.

required
is_default
boolean

Indicates if this is the default suppression group.

required

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.