エラーフィルター

エラーフィルター登録情報更新

概要

指定されたメールアドレスのエラーカウントを設定・リセットする機能です。

注意事項

  • エラーアドレスを一度に大量にリセットすると、エラー率が上がり、配信の遅延やブロックが発生する恐れがあります。

この機能を利用して、特定のメールアドレスへの配信を抑止することも可能です。その際は、設定値を「99」など、意図的に設定したとわかる値を設定することをおすすめします。

メソッドとURL

メソッド URL
PUT https://{HOST名}/errorfilter

リクエスト

ボディパラメーター

JSON形式で設定します。

項目 型 必須 説明
items Object Array ◯ エラーフィルターに登録・更新する対象のリスト。
下記のパラメーターの組合せを配列で指定し、リクエストすることが可能。
一度のリクエストで指定可能な件数は最大100件です。
address String ◯ エラーカウントを設定するアドレス。
指定されたメールアドレスがエラーフィルターに未登録の場合は新規登録します。
count Number エラーカウントに設定する値。
「0~99」までの値が設定可能。
項目の省略が可能。
項目の省略時および「0」を指定した場合には、エラー数をリセットします。

レスポンス

ステータスコード

コード   説明
200 OK リクエスト受付、正常終了。
400 Bad Request 構文不正。フォーマットやパラメーターの不正。
413 Request Entity Too Large 指定したアドレス件数が所定値を超えている。
500 Internal Server Error 想定外のエラー。 しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。その場合は、HTTPレスポンスステータスコード一覧をご確認ください。

HTTPレスポンスステータスコード一覧

ボディパラメーター

項目 型 説明
items Object Array リクエストされたリストの登録内容。
配列で結果が格納されます。
address String リクエスト時に指定したメールアドレス。
count Number 対象のメールアドレスに登録されたエラーカウント。
registered_date String 対象のメールアドレスが、エラーフィルターに初回登録された日時。
バウンスメールもしくは本APIによって登録されます。
update_date String 対象のメールアドレスが更新された最終更新日時。
count Number itemsに設定されたデータの件数。
message String 全体的な失敗時に設定される補足メッセージ。

リクエスト

リクエストサンプル

{
  "items":[
    {
      "address":"xxx@example.com",
      "count":0
    },
    {....}
  ]
}

レスポンスサンプル

正常

{
  "items": [
    {
      "address": "xxx@example.com",
      "count": 1
      "registered_date": "yyyy-mm-ddThh:mm+09:00",
      "update_date": "yyyy-mm-ddThh:mm+09:00"
    },
    {...}
  ],
  "count": 2
}

指定した回数に変更されます。

エラー

{
  "message": "Too Many Requests"
}

補足情報が返却されます。