Suppression Groups

メール送信時にUnsubscribe Groups(配信停止グループ)を指定する

配信停止グループの指定方法はメールの送信方法によって異なります:

  • SMTPで送信する場合、X-SMTPAPIヘッダでグループIDを指定してください
  • Web API v2で送信する場合、x-smtpapiパラメータでグループIDを指定してください
  • Web API v3で送信する場合、asm.group_idパラメータでグループIDを指定してください

1回の送信につき1グループしか設定できません。また、グループ作成後はグループが利用できるようになるまで1分程度待つ必要があります。

1
2
3
{
  "asm_group_id": 1
}

PreferencesページへのUnsubscribe Group(配信停止グループ)の表示設定

Preferencesページに表示するグループを指定する場合、SMTPでX-SMTPAPIヘッダもしくはWeb APIのMailエンドポイントmail.send API callでグループidを追加してください。 asm_groups_to_displayが省略されると、Preferencesページにはデフォルトグループが表示されます。

表示するグループは最大25まで指定できます。

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

グループ

グループIDはSuppressoin GroupsのUI上、もしくは、GroupリソースのGET エンドポイントで確認することができます。

関連ドキュメント: