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

Add recipient addresses to the global suppression group.



API Overview

api-overview page anchor

Global suppressions are the email addresses of recipients who have indicated that they would like unsubscribe from all the email you send by clicking on the Unsubscribe From All Emails link within your emails. Once a recipient's address is on the global suppressions list, they will not receive any emails from you.


POST/v3/asm/suppressions/global

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

This endpoint allows you to add one or more email addresses to the global suppressions group.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

SchemaExample
recipient_emailsarray[string<email>]required

The array of email addresses to add or find.

201
SchemaExample
recipient_emailsarray[string<email>]

The email addresses that are globally suppressed

Add recipient addresses to the global suppression group.

add-recipient-addresses-to-the-global-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 data = {
_24
"recipient_emails": [
_24
"test1@example.com",
_24
"test2@example.com"
_24
]
_24
};
_24
_24
const request = {
_24
url: `/v3/asm/suppressions/global`,
_24
method: 'POST',
_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: