On this page

Add suppressions to 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

POST/v3/asm/groups/{group_id}/suppressions

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 add email addresses to an unsubscribe group.

If you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.

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 unsubscribe group that you are adding suppressions to.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

recipient_emailsarray[string<email>]required

The array of email addresses to add or find.

Responses

201

SchemaExample

Property nameTypeRequiredDescriptionChild properties

recipient_emailsarray[string<email>]

The email addresses you added to the unsubscribe group

Add suppressions to a suppression group

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