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

Delete a suppression from a suppression group



API Overview

api-overview page anchor

Suppressions are recipient email addresses that are added to unsubscribe groups. Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group.


DELETE/v3/asm/groups/{group_id}/suppressions/{email}

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

This endpoint allows you to remove a suppressed email address from the given suppression group.

Removing an address will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our bypass filters to deliver messages to otherwise suppressed addresses when exceptions are required.


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 that you are removing an email address from.


emailstringrequired

The email address that you want to remove from the suppression group.

204
Schema
Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete a suppression from a suppression group

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

_20
const client = require('@sendgrid/client');
_20
client.setApiKey(process.env.SENDGRID_API_KEY);
_20
_20
const group_id = "ZGkrHSypTsudrGkmdpJJ";
_20
const email = "annahamilton@example.org";
_20
_20
const request = {
_20
url: `/v3/asm/groups/${group_id}/suppressions/${email}`,
_20
method: 'DELETE',
_20
_20
}
_20
_20
client.request(request)
_20
.then(([response, body]) => {
_20
console.log(response.statusCode);
_20
console.log(response.body);
_20
})
_20
.catch(error => {
_20
console.error(error);
_20
});


Rate this page: