Unsubscribes

このエンドポイントを含むWeb API v2の機能は、2025年2月に提供を終了します。

今後はWeb API v3をご利用ください。

このエンドポイントでは配信停止リストの一覧取得と削除を行うことができます。

get

配信停止リストの一覧取得を行います。オプションで日付を指定することも可能です。

URI引数 必須 条件 説明
date No 1をセットします 配信停止レコードのタイムスタンプを取得します。MySQLのタイムスタンプフォーマット - YYYY-mm-dd HH:MM:SSが返ります
days No 指定する場合、正の整数 指定した過去の日数分配信停止リストを取得します(今日を含みます)
start_date No YYYY-mm-ddフォーマットで指定する必要があります。end_dateより早い日付を指定します。 配信停止リストを取得する期間の開始日を指定します
end_date No YYYY-mm-ddフォーマットで指定する必要があります。start_dateより遅い日付を指定します。 配信停止リストを取得する期間の終了日を指定します
limit No 整数 応答結果で取得するリスト数の上限を指定します
offset No 整数 一覧取得するリストの初期位置を指定します
email No メールアドレス。例：testing@example.com 検索対象のメールアドレス
Parameter Value Requirements Description 
1

2546776434

Call

GET https://api.sendgrid.com/api/unsubscribes.get.json?api_user=apikey&api_key=your_sendgrid_api_key&date=1

Response

1
2
3
4
5
6

[
  {
    "email": "example@example.com",
    "created": "2012-09-06 14:03:18"
  }
]

Call

GET https://api.sendgrid.com/api/unsubscribes.get.xml?api_user=apikey&api_key=your_sendgrid_api_key&date=1

Response

1
2
3
4
5
6

<unsubscribes>
   <unsubscribe>
      <email>example@example.com</email>
      <created>2012-09-06 14:03:18</created>
   </unsubscribe>
</unsubscribes>

delete

配信停止リストからアドレスを削除します。リストから全てのアドレスを削除する場合、delete_all=1を指定してください。

URI引数 必須 条件 説明
email No 有効なユーザアカウントのメールアドレスである必要があります 配信停止リストから削除するメールアドレス
Parameter Value Requirements Description 
1

3864777225

Call

POST https://api.sendgrid.com/api/unsubscribes.delete.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=emailToDelete@domain.com

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/unsubscribes.delete.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=emailToDelete@domain.com

Response

1
2
3

<result>
   <message>success</message>
</result>

add

配信停止リストにメールアドレスを追加します。

URI引数 必須 条件 説明
email Yes 有効なユーザアカウントのメールアドレスである必要があります 配信停止リストに追加するメールアドレス
Parameter Value Requirements Description 
1

9133495557

Call

POST https://api.sendgrid.com/api/unsubscribes.add.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=email2@domain.com

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/unsubscribes.add.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=email2@domain.com

Response

1
2
3

<result>
   <message>success</message>
</result>