EmailRep · Schema

ReportResponse

Outcome of a report submission.

SecurityEmailEmail ReputationThreat IntelligencePhishingFraud PreventionAnti-AbuseDeliverabilityRisk ScoringPublic APIs

Properties

Name Type Description
status string Outcome of the report submission.
reason string Human-readable failure reason. Present when `status` is `fail`.
View JSON Schema on GitHub

JSON Schema

api-report-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/emailrep/refs/heads/main/json-schema/api-report-response-schema.json",
  "title": "ReportResponse",
  "description": "Outcome of a report submission.",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Outcome of the report submission.",
      "enum": [
        "success",
        "fail"
      ],
      "example": "success"
    },
    "reason": {
      "type": "string",
      "description": "Human-readable failure reason. Present when `status` is `fail`.",
      "example": "invalid email address"
    }
  },
  "required": [
    "status"
  ]
}