機能説明
メールアドレスが、ブラックリストに登録されているかを確認します。
リクエスト
エンドポイント
/v1/blacklists/[メールアドレス]
HTTPメソッド
GET
リクエストボディ
なし
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| メールアドレスが不正 | 400 |
| 認証失敗 | 401 |
| 存在しないエンドポイント | 404 |
| 許可されていないHTTPメソッド | 405 |
| メールアドレスが存在しない | 410 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| code | 数値 | 1 | ステータスコード |
| address | 文字列 | 1 | 対象のメールアドレス |
| exists | 真偽値 | 1 | 登録されていることを示します（常にtrue） |
成功
{
"code":200,
"address":"test@example.com",
"exists":true
}
失敗
{"code":400,"validation_errors":{"address":"must be email address"}}
{"code":401,"description":"invalid token","error":"authentication failed"}
{"code":410}