AhaSend · JSON Structure

Openapi V2 Suppression Structure

Suppression schema from AhaSend API

Type: object Properties: 8 Required: 6
EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Suppression is a JSON Structure definition published by AhaSend, describing 8 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

object id created_at updated_at email domain reason expires_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-structure/openapi-v2-suppression-structure.json",
  "name": "Suppression",
  "description": "Suppression schema from AhaSend API",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "suppression"
      ],
      "description": "Object type identifier",
      "example": "suppression"
    },
    "id": {
      "type": "uuid",
      "description": "Unique identifier for the suppression",
      "example": "500123"
    },
    "created_at": {
      "type": "datetime",
      "description": "When the suppression was created",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "description": "When the suppression was last updated",
      "example": "2025-03-15T14:30:00Z"
    },
    "email": {
      "type": "string",
      "description": "Suppressed email address",
      "example": "user@example.com"
    },
    "domain": {
      "type": "string",
      "nullable": true,
      "description": "Domain for which the email is suppressed",
      "example": "mail.example.com"
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "description": "Reason for suppression",
      "example": "example_value"
    },
    "expires_at": {
      "type": "datetime",
      "description": "When the suppression expires",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "required": [
    "object",
    "id",
    "created_at",
    "updated_at",
    "email",
    "expires_at"
  ]
}