AhaSend · Schema

CreateSuppressionRequest

CreateSuppressionRequest schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
email string Email address to suppress
domain string Domain for which to suppress the email
reason string Reason for suppression
expires_at string When the suppression expires (RFC3339 format)
View JSON Schema on GitHub

JSON Schema

openapi-v2-create-suppression-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-schema/openapi-v2-create-suppression-request-schema.json",
  "title": "CreateSuppressionRequest",
  "description": "CreateSuppressionRequest schema from AhaSend API",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address to suppress",
      "example": "[email protected]"
    },
    "domain": {
      "type": "string",
      "format": "hostname",
      "description": "Domain for which to suppress the email",
      "example": "mail.example.com"
    },
    "reason": {
      "type": "string",
      "maxLength": 255,
      "description": "Reason for suppression",
      "example": "example_value"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the suppression expires (RFC3339 format)",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "required": [
    "email",
    "expires_at"
  ],
  "example": {
    "email": "[email protected]",
    "domain": "example.com",
    "reason": "User requested removal",
    "expires_at": "2024-12-25T10:30:00Z"
  }
}