Blocks

このエンドポイントではブロックリストの一覧取得と削除を行うことができます。

get

アドレス、応答コード指定でブロックリストの一覧取得を行います。オプションで日付を指定することも可能です。

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

Call

GET https://api.sendgrid.com/api/blocks.get.json?api_user=your_sendgrid_username&api_key=your_sendgrid_password&date=1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[
  {
    "status": "4.0.0",
    "created": "2012-09-02 00:12:12",
    "reason": "550 Access denied...04d52d35b93501d500a9bca895ddad5cddd1a9f8486c89ace8c5e959398198cd49cd58288c9d11313975284d852811... (throttled)",
    "email": "example@juno.com"
  },
  {
    "status": "4.0.0",
    "created": "2012-09-02 00:21:29",
    "reason": "Connection timed out",
    "email": "example2@band.la"
  },
  {
    "status": "4.0.0",
    "created": "2012-09-02 00:25:33",
    "reason": "Unable to resolve MX record for exampledomain.com: nxdomain",
    "email": "example3@exampledomain.com"
  }
]

Call

GET https://api.sendgrid.com/api/blocks.get.xml?api_user=your_sendgrid_username&api_key=your_sendgrid_password&date=1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<blocks>
   <block>
      <email>email1@domain.com</email>
      <status>5.1.1</status>
      <reason>host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email1@domain.com</reason>
      <created>2009-06-10 12:40:30</created>
   </block>
   <block>
      <email>email2@domain2.com</email>
      <status>5.1.1</status>
      <reason>host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email2@domain2.com</reason>
      <created>2009-08-01 10:16:30</created>
   </block>
</blocks>

delete

ブロックリストからアドレスを削除します。

URI引数 必須 条件 説明
email true 有効なユーザアカウントのメールアドレスである必要があります 削除するブロックされたメールアドレス

Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/blocks.delete.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com

Response

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

Call

POST https://api.sendgrid.com/api/blocks.delete.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com

Response

1
2
3
4
<result>
   <count>4</count>
   @nodes
</result>

count

URI引数 必須 条件 説明
start_date false YYYY-mm-ddフォーマットで指定する必要があります。end_dateより早い日付を指定します。 カウントする期間の開始日
end_date false YYYY-mm-ddフォーマットで指定する必要があります。start_dateより遅い日付を指定します。 カウントする期間の終了日
type false hardまたはsoft 検索するバウンスのタイプ
Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/blocks.count.json?api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
{
  "count": "4"
}

Call

GET https://api.sendgrid.com/api/blocks.count.xml?api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
<result>
   <count>4</count>
</result>