Subuser Unsubscribes

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

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

Retrieve Unsubscribes

URI引数 必須 条件 説明
task Yes getを指定します 指定したサブユーザの配信停止リストを取得します
user Yes 親アカウント配下に登録されているサブユーザ 配信停止リストを取得するサブユーザ
date No 0 または 1 ISO-8601フォーマットでタイムスタンプを取得する場合の任意の引数です。Pacific Timezoneで取得できます。フォーマット: YYYY-MM-DD HH:MM:SS
Parameter Value Requirements Description 
1

4936428394

Call

POST https://api.sendgrid.com/api/user.unsubscribes.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=get&date=1

Response

1
2
3
4
5
6
7
8
9
10

[
  {
    "email": "emaieexampexample@example.com",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "emaieexampexample@example.com",
    "created": "2009-06-01 19:41:39"
  }
]

Call

POST https://api.sendgrid.com/api/user.unsubscribes.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=get&date=1

Response

1
2
3
4
5
6
7
8
9
10

<unsubscribes>
   <unsubscribe>
      <email>emaieexampexample@example.com</email>
      <created>2009-06-10 12:40:30</created>
   </unsubscribe>
   <unsubscribe>
      <email>emaieexampexample@example.com</email>
      <created>2009-06-10 12:40:30</created>
   </unsubscribe>
</unsubscribes>

Delete Unsubscribes

SendGridは配信停止されたアドレスに対してメールを送信しないため、ユーザが再送信を希望する場合、配信停止リストから削除する必要があります。

URI引数 必須 条件 説明
task Yes deleteを指定します 指定したサブユーザの配信停止リストからアドレスを削除します
user Yes 親アカウント配下に登録されているサブユーザ 配信停止リストから削除するサブユーザ
email Yes 配信停止リストに含まれるメールアドレス 削除するメールアドレスを指定します
Parameter Value Requirements Description 
1

8983895936

Call

POST https://api.sendgrid.com/api/user.unsubscribes.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=delete&email=unsubscribe@sample.com

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/user.unsubscribes.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=delete&email=unsubscribe@sample.com

Response

1
2
3

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

Add Unsubscribes

特定のアドレスに対してメール送信させたくない場合、配信停止リストにアドレスを追加します。

URI引数 必須 条件 説明
task Yes addを指定します 指定したサブユーザの配信停止リストにアドレスを追加します
user Yes 親アカウント配下に登録されているサブユーザ 配信停止リストにアドレスを追加するサブユーザ
email Yes 配信停止リストに含まれるメールアドレス 追加するメールアドレスを指定します
Parameter Value Requirements Description 
1

8554550652

Call

POST https://api.sendgrid.com/api/user.unsubscribes.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=add&email=unsubscribe@sample.com

Response

1
2
3

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/user.unsubscribes.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=add&email=unsubscribe@sample.com

Response

1
2
3

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