Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Suppression Groups



Defining an Unsubscribe Group When Sending

defining-an-unsubscribe-group-when-sending page anchor

The method used to specify an unsubscribe group for an email depends on how you will be sending that email:

(error)

Danger

You may only specify one group per send, and you should wait one minute after creating the group before sending with it.

(error)

Danger

When passing asm_group_id please make sure to only use integers as shown in our examples. Any other type could result in unintended behavior.


_10
{
_10
"asm_group_id": 1
_10
}


Defining Unsubscribe Groups to display on the Manage Preferences page

defining-unsubscribe-groups-to-display-on-the-manage-preferences-page page anchor

To specify which groups to display on the Manage Preferences page of an email, add the group IDs to the X-SMTPAPI header of an SMTP message, or in the x-smtpapi parameter of a mail.send API call(link takes you to an external page). If you omit the asm_groups_to_display header, your default groups is shown on the Manage Preferences page instead.

(error)

Danger

You can specify up to 25 groups to display.


_10
{
_10
"asm_groups_to_display": [1, 2, 3]
_10
}


You can find your group IDs by looking at the Group ID column in the Unsubscribe Groups UI, or by calling the GET method(link takes you to an external page) of the groups resource.

Related Articles:



Rate this page: