Menu

Expand
Rate this page:

Suppressions - Suppressions

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.

Retrieve all suppression groups for an email address

GET /v3/asm/suppressions/{email}

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

This endpoint returns a list of all groups from which the given email address has been unsubscribed.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Path Parameters

email
string

The email address that you want to search suppression groups for.

default: None
required

Responses

object
suppressions
array[object]

The array of suppression groups.

required
description
string

The description of the suppression group.

id
integer

The id of the suppression group.

is_default
boolean

Indicates if the suppression group is set as the default.

name
string

The name of the suppression group.

suppressed
boolean

Indicates if the given email address is suppressed for this group.

        
        
        
        Rate this page:

        Need 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.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more