SendGrid

Twilio SendGrid Suppressions API

The Twilio SendGrid Suppressions API allows you to manage your Suppressions or Unsubscribes and Suppression or Unsubscribe groups. With SendGrid, an…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Twilio SendGrid Suppressions API allows you to manage your Suppressions or Unsubscribes and Suppression or Unsubscribe groups. With SendGrid, an unsubscribe is the action an email recipient takes when they opt-out of receiving your messages. A suppression is the action you take as a sender to filter or suppress an unsubscribed address from your email send. From the perspective of the recipient, your suppression is the result of their unsubscribe.

You can have global suppressions, which represent addresses that have been unsubscribed from all of your emails. You can also have suppression groups, also known as ASM groups, which represent categories or groups of emails that your recipients can unsubscribe from, rather than unsubscribing from all of your messages.

SendGrid automatically suppresses emails sent to users for a variety of reasons, including blocks, bounces, invalid email addresses, spam reports, and unsubscribes. SendGrid suppresses these messages to help you maintain the best possible sender reputation by attempting to prevent unwanted mail. You may also add addresses to your suppressions.

See Suppressions for more information.

Endpoints 33

Suppressions

  • GETRetrieve all suppressions for a suppression group/v3/asm/groups/:group_id/suppressionsThis endpoint allows you to retrieve all suppressed email addresses belonging to the given group.
  • POSTAdd suppressions to a suppression group/v3/asm/groups/:group_id/suppressionsThis endpoint allows you to add email addresses to an unsubscribe group. If you attempt to add suppressions to a group that has been deleted or does not…
  • DELETEDelete a suppression from a suppression group/v3/asm/groups/:group_id/suppressions/:emailThis endpoint allows you to remove a suppressed email address from the given suppression group. Removing an address will remove the suppression, meaning email…
  • POSTSearch for suppressions within a group/v3/asm/groups/:group_id/suppressions/searchThis endpoint allows you to search a suppression group for multiple suppressions. When given a list of email addresses and a group ID, this endpoint will only…
  • GETRetrieve all suppressions/v3/asm/suppressionsThis endpoint allows you to retrieve a list of all suppressions.
  • GETRetrieve all suppression groups for an email address/v3/asm/suppressions/:emailThis endpoint returns a list of all groups from which the given email address has been unsubscribed.

Global Suppressions

  • POSTAdd recipient addresses to the global suppression group./v3/asm/suppressions/globalThis endpoint allows you to add one or more email addresses to the global suppressions group.
  • GETRetrieve a Global Suppression/v3/asm/suppressions/global/:emailThis 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…
  • DELETEDelete a Global Suppression/v3/asm/suppressions/global/:emailThis endpoint allows you to remove an email address from the global suppressions group. Deleting a suppression group will remove the suppression, meaning…
  • GETRetrieve all global suppressions/v3/suppression/unsubscribes?start_time=0&end_time=0&limit=1&offset=0&email=stringThis endpoint allows you to retrieve a paginated list of all email address that are globally suppressed. You can use the limit query parameter to set the page…

Unsubscribe Groups

  • GETRetrieve all suppression groups associated with the user./v3/asm/groups?id=0This endpoint allows you to retrieve a list of all suppression groups created by this user. This endpoint can also return information for multiple group IDs…
  • POSTCreate a new suppression group/v3/asm/groupsThis endpoint allows you to create a new suppression group. To add an email address to the suppression group, create a Suppression.
  • GETGet information on a single suppression group./v3/asm/groups/:group_idThis endpoint allows you to retrieve a single suppression group.
  • DELETEDelete a Suppression Group/v3/asm/groups/:group_idThis endpoint allows you to delete a suppression group. If a recipient uses the "one-click unsubscribe" option on an email associated with a deleted group,…
  • PATCHUpdate a suppression group./v3/asm/groups/:group_idThis endpoint allows you to update or change a suppression group.

Blocks

  • GETRetrieve all blocks/v3/suppression/blocks?start_time=0&end_time=0&limit=1&offset=0&email=stringThis endpoint allows you to retrieve a paginated list of all email addresses that are currently on your blocks list. You can use the limit query parameter to…
  • DELETEDelete blocks/v3/suppression/blocksThis endpoint allows you to delete all email addresses on your blocks list. There are two options for deleting blocked emails: 1. You can delete all blocked…
  • GETRetrieve a specific block/v3/suppression/blocks/:emailThis endpoint allows you to retrieve a specific email address from your blocks list.
  • DELETEDelete a specific block/v3/suppression/blocks/:emailThis endpoint allows you to delete a specific email address from your blocks list.

Bounces

  • GETRetrieve all bounces/v3/suppression/bounces?start_time=0&end_time=0&limit=1&offset=0&email=stringThis endpoint allows you to retrieve a paginated list of all your bounces. You can use the limit query parameter to set the page size. If your list contains…
  • DELETEDelete bounces/v3/suppression/bouncesThis endpoint allows you to delete all emails on your bounces list. There are two options for deleting bounced emails: 1. You can delete all bounced emails by…
  • GETRetrieve a Bounce/v3/suppression/bounces/:emailThis endpoint allows you to retrieve a specific bounce by email address.
  • DELETEDelete a bounce/v3/suppression/bounces/:emailThis endpoint allows you to remove an email address from your bounce list.
  • GETRetrieve bounce classification totals/v3/suppression/bounces/classifications?start_date=string&end_date=stringThis endpoint will return the total number of bounces by classification in descending order for each day. You can retrieve the bounce classification totals in…
  • GETRetrieve bounce classification over time by domain stats/v3/suppression/bounces/classifications/:classification?start_date=string&end_date=stringThis endpoint will return the number of bounces for the classification specified in descending order for each day. You can retrieve the bounce classification…

Invalid Emails

  • GETRetrieve all invalid emails/v3/suppression/invalid_emails?start_time=0&end_time=0&limit=1&offset=0&email=stringThis endpoint allows you to retrieve a paginated list of all invalid email addresses. You can use the limit query parameter to set the page size. If your list…
  • DELETEDelete invalid emails/v3/suppression/invalid_emailsThis endpoint allows you to remove email addresses from your invalid email address list. There are two options for deleting invalid email addresses: 1) You…
  • GETRetrieve a specific invalid email/v3/suppression/invalid_emails/:emailThis endpoint allows you to retrieve a specific invalid email addresses.
  • DELETEDelete a specific invalid email/v3/suppression/invalid_emails/:emailThis endpoint allows you to remove a specific email address from the invalid email address list.

Spam Reports

  • GETRetrieve all spam reports/v3/suppression/spam_reports?start_time=0&end_time=0&limit=1&offset=0&email=stringThis endpoint allows you to retrieve a paginated list of all spam reports. You can use the limit query parameter to set the page size. If your list contains…
  • DELETEDelete spam reports/v3/suppression/spam_reportsThis endpoint allows you to delete your spam reports. Deleting a spam report will remove the suppression, meaning email will once again be sent to the…
  • GETRetrieve a specific spam report/v3/suppression/spam_reports/:emailThis endpoint allows you to retrieve a specific spam report by email address.
  • DELETEDelete a specific spam report/v3/suppression/spam_reports/:emailThis endpoint allows you to delete a specific spam report by email address. Deleting a spam report will remove the suppression, meaning email will once again…

API details

Base URL
https://api.sendgrid.com
https://api.eu.sendgrid.com
Authentication
A bearer token in the Authorization header
Operations
33 operations on 20 pathsGET 17DELETE 11POST 4PATCH 1
Main resources
Bounces 6Suppressions 6Unsubscribe Groups 5Blocks 4Global Suppressions 4Invalid Emails 4Spam Reports 4
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Twilio SendGrid Suppressions API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Suppressions API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve all suppressions for a suppression group” (GET /v3/asm/groups/:group_id/suppressions), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio SendGrid Suppressions API?

The Twilio SendGrid Suppressions API allows you to manage your Suppressions or Unsubscribes and Suppression or Unsubscribe groups. With SendGrid, an… It is listed under Communication and has 33 endpoints.

Who publishes the Twilio SendGrid Suppressions API?

It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio SendGrid Suppressions API?

Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Twilio SendGrid Suppressions API?

With A bearer token in the Authorization header.

How many endpoints does the Twilio SendGrid Suppressions API have?

33 operations on 20 paths (17 GET, 11 DELETE, 4 POST, 1 PATCH). The largest groups are Bounces, Suppressions, Unsubscribe Groups, Blocks.

Is forking the Twilio SendGrid Suppressions API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.