Suppressions

SuppressionsはGroupsにメールアドレスを追加して、あるタイプのメールをそのアドレスに配信しないようにする場合に利用します。

GET

全サプレッションを取得します。

Request

1

GET https://api.sendgrid.com/v3/asm/suppressions HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

HTTP/1.1 200
[
  {
    "email":"test@example.com",
    "group_id": 1,
    "group_name": "Weekly News",
    "created_at": 1410986704
  },
  {
    "email":"test1@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  },
  {
    "email":"test2@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  }
]

GET

指定したメールアドレスが追加されている全ての配信停止グループを取得します。

URI引数 必須 条件 説明
email Yes String 全グループをまたいで検索するメールアドレス

Request

1

GET https://api.sendgrid.com/v3/asm/suppressions/{email} HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

HTTP/1.1 200
{
  "suppressions": [
    {
        "description": "Optional description.",
        "id": 1,
        "is_default": true,
        "name": "Weekly News",
        "suppressed": true
    },
    {
        "description": "Some daily news.",
        "id": 2,
        "is_default": true,
        "name": "Daily News",
        "suppressed": true
    },
    {
        "description": "An old group.",
        "id": 2,
        "is_default": false,
        "name": "Old News",
        "suppressed": false
    }
  ]
}

POST

指定したグループのサプレッションリストに宛先アドレスを追加します。

グループが削除されていた場合、宛先アドレスはグローバルサプレッションに追加されます。

URI引数 必須 条件 説明
recipient_emails Yes 有効なメールアドレスの配列 グループに追加するメールアドレス

Request

1

POST https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions HTTP/1.1

Response

1
2
3
4
5
6
7

HTTP/1.1 201
{
  "recipient_emails":[
    "test1@example.com",
    "test2@example.com"
  ]
}

GET

指定したグループに所属しているサプレッションアドレスリストを取得します。

Request

1

GET https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions HTTP/1.1

Response

1
2
3
4
5

HTTP/1.1 200
[
  "test1@example.com",
  "test2@example.com"
]

DELETE

指定したグループのサプレッションリストから宛先アドレスを削除します。

Request

1

DELETE https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions/:email_address HTTP/1.1

Response

1

HTTP/1.1 204

POST

このエンドポイントは指定したサプレッショングループ内に指定したメールアドレスが存在するか確認するのに使用できます。

メールアドレス一覧とグループIDが指定されると、このエンドポイントは指定されたグループから配信停止されたメールアドレスのみを返します。

URI引数 必須 条件 説明
group_id Yes integer 検索対象のグループIDです。

Request

1

POST https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions/search HTTP/1.1
Request Body
1
2
3
4
5
6
7

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

Response

1
2
3
4
5
6
7
8

HTTP/1.1 200

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