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.

Add suppressions to a suppression group

Add suppressions to a suppression group

POST /asm/groups/{group_id}/suppressions

This 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 exist, the suppressions will be added to the global suppressions list.

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.

Request Body

object
recipient_emails
array[string]

The array of email addresses to add or find.

required
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}

Path Parameters

group_id
string

The id of the unsubscribe group that you are adding suppressions to.

required

Responses

object
recipient_emails
array[string]

The email addresses you added to the unsubscribe 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.