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

Retrieve a Global Suppression



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.


GET/v3/asm/suppressions/global/{email}

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

This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.

If the email address you include in the URL path parameter {email} is already globally suppressed, the response will include that email address. If the address you enter for {email} is not globally suppressed, an empty JSON object {} will be returned.


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.

emailstringrequired

The email address of the global suppression you want to retrieve. Or, if you want to check if an email address is on the global suppressions list, enter that email address here.

200
SchemaExample
recipient_emailstring<email>

The email address that is globally suppressed. This will be an empty object if the email address you included in your call is not globally suppressed.

Retrieve a Global Suppression

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

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


Rate this page: