On this page

Delete a suppression from a suppression group

API Overview

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.

Operation overview

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

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 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.

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

emailstringrequired

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

Responses

204

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete a suppression from a suppression group

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const group_id = "ZGkrHSypTsudrGkmdpJJ";
5const email = "annahamilton@example.org";
6
7const request = {
8  url: `/v3/asm/groups/${group_id}/suppressions/${email}`,
9  method: 'DELETE',
10  
11}
12
13client.request(request)
14  .then(([response, body]) => {
15    console.log(response.statusCode);
16    console.log(response.body);
17  })
18  .catch(error => {
19    console.error(error);
20  });