Retrieve all suppression groups for an email address

Twilio

Menu

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

Retrieve all suppression groups for an email address

GET /asm/suppressions/{email}

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.

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.

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.