Unsubscribe Groups

Groupsは受信者が配信停止を可能にするメールのタイプ(ニュースレター、請求書、警告など)を表します。

グループの namedescription は、メールの受信者が配信停止を管理する際、受信者から見えます。

POST

グループを作成します。

作成可能なグループ数の上限は25です。

URI引数 必須 条件 説明
name Yes アカウント内で一意となる30文字以内の文字列。 新しく作成するグループの名前
description Yes 100文字以内の文字列。 グループの説明
is_default No Boolean デフォルト値はfalse

Request

1
POST https://api.sendgrid.com/v3/asm/groups HTTP/1.1
Request Body
1
2
3
4
5
{
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": true
}

Response

1
2
3
4
5
6
7
8
HTTP/1.1 201 OK

{
  "id":103,
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": false
}

GET

全グループを取得します。

Request

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

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
  {
    "id": 100,
    "name": "Newsletters",
    "description": "Our monthly newsletter.",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 400
  },
  {
    "id": 101,
    "name": "Alerts",
    "description 2": "Emails triggered by user-defined rules.",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1
  }
]

GET

指定したグループの情報を取得します。

Request

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

Response

1
2
3
4
5
6
7
8
{
    "id": 100,
    "name": "Newsletters",
    "description": "Our monthly newsletter.",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 400
}

PATCH

グループを編集します。

URI引数 必須 条件 説明
name No アカウント内で一意となる30文字以内の文字列。 編集するグループの名前
description No 100文字以内の文字列。 グループの説明

Request

1
PATCH https://api.sendgrid.com/v3/asm/groups/:group_id HTTP/1.1

Response

1
2
3
4
5
6
7
HTTP/1.1 201 OK

{
  "id":103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}

GET

複数のサプレッショングループについての情報を取得します。

このエンドポイントは要求にて指定した各グループIDについての情報を返します。要求でグループIDを指定するには、&id=の後にグループIDを指定してください。

URI引数 必須 条件 説明
id No Integer 情報取得するサプレッショングループのID

Request

1
GET https://api.sendgrid.com/v3/asm/groups?id={id1}&id={id2} HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
HTTP/1.1 200 OK

[
  {
    "id": 100,
    "name": "Newsletters",
    "description": "Our monthly newsletter.",
    "last_email_sent_at": null,
    "is_default" : true,
    "unsubscribes": 400
  },
  {
    "id": 101,
    "name": "Alerts",
    "description 2": "Emails triggered by user-defined rules.",
    "last_email_sent_at": null,
    "is_default" : false,
    "unsubscribes": 1
  }
]

DELETE

グループを削除します。

60日以内に利用されていないグループのみ削除可能です。メール受信者が、削除されたグループに関連したメールの「one-click unsubscribe」オプションを利用していた場合、その受信者はグローバルサプレッションリストに追加されます。

Request

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

Response

1
HTTP/1.1 204 NO CONTENT (OK)

Response

1
2
3
4
5
HTTP/1.1 400

{
  "error":"refusing to delete active group: group has been sent to within the past 60 days"
}