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.
This endpoint allows you to retrieve a list of all suppressions.
Bearer <<YOUR_API_KEY_HERE>>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.
Array of:
The email address that was suppressed.
The id of the suppression group that this email address belongs to.
The name of the suppression group that this email address belongs to.
A UNIX timestamp indicating when the suppression was created.
1const client = require('@sendgrid/client');2client.setApiKey(process.env.SENDGRID_API_KEY);345const request = {6url: `/v3/asm/suppressions`,7method: 'GET',89}1011client.request(request)12.then(([response, body]) => {13console.log(response.statusCode);14console.log(response.body);15})16.catch(error => {17console.error(error);18});