On this page

Update a suppression group.

API Overview

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.

Operation overview

PATCH/v3/asm/groups/{group_id}

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 update or change a suppression group.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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.

Path parameters

Property nameTypeRequiredDescription

group_idstringrequired

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

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

namestringOptional

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

Max length: 30

descriptionstringOptional

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

Max length: 100

is_defaultbooleanOptional

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

Responses

201

SchemaExample

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

last_email_sent_atinteger or null

is_defaultboolean

Indicates if this is the default suppression group.

Default: false

unsubscribesinteger

The unsubscribes associated with this group.

Update a suppression group.

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const group_id = "ZGkrHSypTsudrGkmdpJJ";
5const data = {
6  "id": 103,
7  "name": "Item Suggestions",
8  "description": "Suggestions for items our users might like."
9};
10
11const request = {
12  url: `/v3/asm/groups/${group_id}`,
13  method: 'PATCH',
14  body: data
15}
16
17client.request(request)
18  .then(([response, body]) => {
19    console.log(response.statusCode);
20    console.log(response.body);
21  })
22  .catch(error => {
23    console.error(error);
24  });