AhaSend · Schema

MessageSummary

MessageSummary schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
object string Object type identifier
created_at string When the message was created
updated_at string When the message was last updated
sent_at string When the message was sent
delivered_at string When the message was delivered
retain_until string When the message data will be purged
direction string Message direction
is_bounce_notification boolean Whether this is a bounce notification
bounce_classification string Classification of bounce if applicable
delivery_attempts array List of delivery attempts for this message
message_id string Message-ID header value
id string API-generated message ID
subject string Message subject
tags array Tags associated with the message
sender string Sender email address
recipient string Recipient email address
status string Current message status
num_attempts integer Number of delivery attempts
click_count integer Number of clicks tracked for this message
open_count integer Number of opens tracked for this message
reference_message_id integer ID of the original message (for bounce messages)
domain_id string Domain ID this message was sent from
account_id string Account ID this message belongs to
View JSON Schema on GitHub

JSON Schema

openapi-v2-message-summary-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-message-summary-schema.json",
  "title": "MessageSummary",
  "description": "MessageSummary schema from AhaSend API",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "message"
      ],
      "description": "Object type identifier",
      "example": "message"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the message was created",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the message was last updated",
      "example": "2025-03-15T14:30:00Z"
    },
    "sent_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the message was sent",
      "example": "2025-03-15T14:30:00Z"
    },
    "delivered_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the message was delivered",
      "example": "2025-03-15T14:30:00Z"
    },
    "retain_until": {
      "type": "string",
      "format": "date-time",
      "description": "When the message data will be purged",
      "example": "2025-03-15T14:30:00Z"
    },
    "direction": {
      "type": "string",
      "enum": [
        "incoming",
        "outgoing"
      ],
      "description": "Message direction",
      "example": "incoming"
    },
    "is_bounce_notification": {
      "type": "boolean",
      "description": "Whether this is a bounce notification",
      "example": true
    },
    "bounce_classification": {
      "type": "string",
      "description": "Classification of bounce if applicable",
      "example": "example_value"
    },
    "delivery_attempts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryEvent"
      },
      "description": "List of delivery attempts for this message",
      "example": [
        {
          "time": "2025-03-15T14:30:00Z",
          "log": "example_value",
          "status": "example_value"
        }
      ]
    },
    "message_id": {
      "type": "string",
      "description": "Message-ID header value",
      "example": "500123"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "API-generated message ID",
      "example": "500123"
    },
    "subject": {
      "type": "string",
      "description": "Message subject",
      "example": "example_value"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags associated with the message",
      "example": [
        "example_value"
      ]
    },
    "sender": {
      "type": "string",
      "format": "email",
      "description": "Sender email address",
      "example": "example_value"
    },
    "recipient": {
      "type": "string",
      "format": "email",
      "description": "Recipient email address",
      "example": "example_value"
    },
    "status": {
      "type": "string",
      "description": "Current message status",
      "example": "example_value"
    },
    "num_attempts": {
      "type": "integer",
      "description": "Number of delivery attempts",
      "example": 1
    },
    "click_count": {
      "type": "integer",
      "description": "Number of clicks tracked for this message",
      "example": 1
    },
    "open_count": {
      "type": "integer",
      "description": "Number of opens tracked for this message",
      "example": 1
    },
    "reference_message_id": {
      "type": "integer",
      "format": "int64",
      "description": "ID of the original message (for bounce messages)",
      "example": 1
    },
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "description": "Domain ID this message was sent from",
      "example": "500123"
    },
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Account ID this message belongs to",
      "example": "500123"
    }
  },
  "required": [
    "object",
    "created_at",
    "updated_at",
    "retain_until",
    "direction",
    "is_bounce_notification",
    "delivery_attempts",
    "message_id",
    "id",
    "subject",
    "tags",
    "sender",
    "recipient",
    "status",
    "num_attempts",
    "click_count",
    "open_count",
    "domain_id",
    "account_id"
  ]
}