Add recipient addresses to the global suppression group.
A global suppression includes the email addresses of recipients who unsubscribed from all emails that you send them.
To unsubscribe from all emails, a recipient clicks the Unsubscribe From All Emails link within your emails. Once a recipient adds their email address to the global suppressions list, they don't receive any emails from you.
POST/v3/asm/suppressions/global
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 one or more email addresses to the global suppressions group.
Bearer <<YOUR_API_KEY_HERE>>
Optional
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>
). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of
header. See On Behalf Of for more information.
application/json
The array of email addresses to add or find.
Optional
The email addresses that are globally suppressed
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5recipient_emails: ["test1@example.com", "test2@example.com"],6};78const request = {9url: `/v3/asm/suppressions/global`,10method: "POST",11body: data,12};1314client15.request(request)16.then(([response, body]) => {17console.log(response.statusCode);18console.log(response.body);19})20.catch((error) => {21console.error(error);22});