エラーフィルター

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

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

エラーフィルターに登録されたメールアドレスのエラーカウントを更新します。 指定されたメールアドレスがない場合は、新規で登録します。

メソッドとURL

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

 

リクエスト

ボディパラメーター

JSON形式で設定します。

項目 型 必須 説明
items Object Array ◯ 取得用データのリスト。
address String ◯ エラーカウントを設定するアドレス。
count Number 設定する値。

 

レスポンス

ステータスコード

コード   説明
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 初回登録日時。
update_date String 最終更新日時。
count Number itemsに設定されたデータの件数。
message String 全体的な失敗時に設定される補足メッセージ。

 

エラーカウントの登録

リクエストで指定されたアドレスに、指定されたカウントを設定します。

補足説明

  • カウントの指定は「0~99」までの値となります。
  • カウントの指定が無ければ、「0」を設定します。
  • メールアドレスがエラーフィルターに未登録の場合は、新規登録します。
注意事項

  • 一度のリクエストで指定可能なアドレスは最大100件までです。
  • エラーカウントを一度に大量に解除することは、配信エラーの原因となります。
 

リクエスト

リクエストサンプル

{
  "items":[
    {
      "address":"xxxxxxxx@xxxx.xx",
      "count":0
    },
    {....}
  ]
}

 

レスポンスサンプル

正常

{
  "items": [
    {
      "address": "xxxxxxxx@xxxx.xx",
      "count": 1
      "registered_date": "yyyy-mm-ddThh:mm+09:00",
      "update_date": "yyyy-mm-ddThh:mm+09:00"
    },
    {...}
  ],
  "count": 2
}

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

エラー

{
 "message": "Too Many Requests"
}

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