Menu

Expand
Rate this page:

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

Update a suppression group.

PATCH /v3/asm/groups/{group_id}

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

This endpoint allows you to update or change a suppression group.

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.

{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}

Path Parameters

group_id
string

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

default: None
required

Responses

object
id
number

The id of the suppression group.

required
name
string

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

maxLength: 30
required
description
string

A description of the suppression group.

maxLength: 100
required
last_email_sent_at
integer or null
is_default
boolean

Indicates if this is the default suppression group.

default: False
unsubscribes
integer

The unsubscribes associated with this group.

        
        
        
        Rate this page:

        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.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more