{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/sendraven-ai/json-schema/sendraven-ai-suppression-schema.json",
  "title": "Suppression",
  "description": "One suppressed address in one scope. The list and POST /v1/suppressions return this same object, with every field present.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sendraven-ai-suppressions-api-openapi.yml#/components/schemas/Suppression",
  "type": "object",
  "required": [
    "id",
    "email",
    "reason",
    "scope",
    "detail",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "email": {
      "type": "string",
      "description": "Trimmed and lower-cased."
    },
    "reason": {
      "type": "string",
      "enum": [
        "hard_bounce",
        "complaint",
        "unsubscribe",
        "manual",
        "list_hygiene"
      ],
      "description": "hard_bounce and complaint are set by SendRaven (or a contact import) with scope all and are never replaced by a weaker reason, so after a POST this can differ from the reason sent. unsubscribe comes from unsubscribe links and the preference centre, with scope marketing. manual and list_hygiene are set by callers."
    },
    "scope": {
      "type": "string",
      "enum": [
        "all",
        "transactional",
        "marketing"
      ],
      "description": "Which mail the suppression blocks, matched against the message's risk class: all blocks everything, transactional only transactional mail, marketing only marketing mail (campaigns, automations and sends marked marketing). Use marketing for someone who asked to stop newsletters, so their password resets still arrive."
    },
    "detail": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 500,
      "description": "The SMTP diagnostic for a bounce, the feedback type for a complaint, how someone unsubscribed, or the import it came from. null when there is none. Never set through this API."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the address was first suppressed with this scope."
    }
  }
}