Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Update a suppression group.



API Overview

api-overview page anchor

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.


PATCH/v3/asm/groups/{group_id}

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

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


Authentication

authentication page anchor
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.

Property nameTypeRequiredDescription
group_idstringrequired

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

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.

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.

update-a-suppression-group page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_24
const client = require('@sendgrid/client');
_24
client.setApiKey(process.env.SENDGRID_API_KEY);
_24
_24
const group_id = "ZGkrHSypTsudrGkmdpJJ";
_24
const data = {
_24
"id": 103,
_24
"name": "Item Suggestions",
_24
"description": "Suggestions for items our users might like."
_24
};
_24
_24
const request = {
_24
url: `/v3/asm/groups/${group_id}`,
_24
method: 'PATCH',
_24
body: data
_24
}
_24
_24
client.request(request)
_24
.then(([response, body]) => {
_24
console.log(response.statusCode);
_24
console.log(response.body);
_24
})
_24
.catch(error => {
_24
console.error(error);
_24
});


Rate this page: