Subuser Bounces

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

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

Retrieve Bounces

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
5179371865

Call

POST https://api.sendgrid.com/api/user.bounces.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
11
12
13
14
[
  {
    "email": "emaieexampexample@example.com",
    "status": "5.1.1",
    "reason": "550 5.1.1 unknown or illegal user: emaieexampexample@example.com",
    "created": "2014-12-06 08:34:48"
  },
  {
    "email": "emaileexampexample@example.com",
    "status": "5.1.1",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at http:\/\/support.google.com\/mail\/bin\/answer.py?answer=6596 qy3si50924603pab.12 - gsmtp ",
    "created": "2014-12-06 08:36:34"
  }
]

Call

POST https://api.sendgrid.com/api/user.bounces.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
11
12
13
14
<bounces>
   <bounce>
      <email>emaieexampexample@example.com</email>
      <status>5.1.1</status>
      <reason>550 5.1.1 unknown or illegal user: emaieexampexample@domain.com</reason>
      <created>2014-12-06 08:34:48</created>
   </bounce>
   <bounce>
      <email>emaileexampexample@example.com</email>
      <status>5.1.1</status>
      <reason>550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at http:\/\/support.google.com\/mail\/bin\/answer.py?answer=6596 qy3si50924603pab.12 - gsmtp </reason>
      <created>2014-12-06 08:36:34</created>
   </bounce>
</bounces>

Delete Bounces

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

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

Call

POST https://api.sendgrid.com/api/user.bounces.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=delete&email=bounceexampexample@example.com

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/user.bounces.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&user=subuser_username&task=delete&email=bounceexampexample@example.com

Response

1
2
3
<result>
   <message>success</message>
</result>