Suppressions - Global Suppressions
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.
Retrieve all global suppressions
GET /v3/suppression/unsubscribes
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve a list of all email address that are globally suppressed.
Authentication
- API Key
Headers
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.
Query String
Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive).
default: NoneRefers end of the time range in unix timestamp when an unsubscribe email was created (inclusive).
default: NoneThe number of results to display on each page.
default: NoneThe point in the list of results to begin displaying global suppressions.
default: NoneResponses
A Unix timestamp indicating when the recipient was added to the global suppression list.
The email address of the recipient who is globally suppressed.
format: emailNeed some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
