AhaSend · Schema

Domain

Domain schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
object string Object type identifier
id string Unique identifier for the domain
created_at string When the domain was created
updated_at string When the domain was last updated
domain string The domain name
account_id string Account ID this domain belongs to
dns_records array DNS records required for domain verification
last_dns_check_at string When DNS records were last checked
dns_valid boolean Whether all required DNS records are properly configured
tracking_subdomain string Custom tracking subdomain. Null means the account or product default is used.
return_path_subdomain string Custom return-path subdomain. Null means the account or product default is used.
subscription_subdomain string Custom subscription management subdomain. Null means the account or product default is used.
media_subdomain string Custom media subdomain. Null means the account or product default is used.
dkim_rotation_interval_days integer Custom DKIM rotation interval in days. Null means the account default is used.
rotation_ready boolean Whether the standby DKIM slot is ready for rotation.
View JSON Schema on GitHub

JSON Schema

openapi-v2-domain-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-domain-schema.json",
  "title": "Domain",
  "description": "Domain schema from AhaSend API",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "domain"
      ],
      "description": "Object type identifier",
      "example": "domain"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the domain",
      "example": "500123"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the domain was created",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the domain was last updated",
      "example": "2025-03-15T14:30:00Z"
    },
    "domain": {
      "type": "string",
      "description": "The domain name",
      "example": "mail.example.com"
    },
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Account ID this domain belongs to",
      "example": "500123"
    },
    "dns_records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DNSRecord"
      },
      "description": "DNS records required for domain verification",
      "example": [
        {
          "type": "example_value",
          "host": "example_value",
          "content": "example_value",
          "required": true,
          "propagated": true
        }
      ]
    },
    "last_dns_check_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time",
      "description": "When DNS records were last checked",
      "example": "2025-03-15T14:30:00Z"
    },
    "dns_valid": {
      "type": "boolean",
      "description": "Whether all required DNS records are properly configured",
      "example": true
    },
    "tracking_subdomain": {
      "type": "string",
      "nullable": true,
      "description": "Custom tracking subdomain. Null means the account or product default is used.",
      "example": "mail.example.com"
    },
    "return_path_subdomain": {
      "type": "string",
      "nullable": true,
      "description": "Custom return-path subdomain. Null means the account or product default is used.",
      "example": "mail.example.com"
    },
    "subscription_subdomain": {
      "type": "string",
      "nullable": true,
      "description": "Custom subscription management subdomain. Null means the account or product default is used.",
      "example": "mail.example.com"
    },
    "media_subdomain": {
      "type": "string",
      "nullable": true,
      "description": "Custom media subdomain. Null means the account or product default is used.",
      "example": "mail.example.com"
    },
    "dkim_rotation_interval_days": {
      "type": "integer",
      "nullable": true,
      "description": "Custom DKIM rotation interval in days. Null means the account default is used.",
      "example": 1
    },
    "rotation_ready": {
      "type": "boolean",
      "description": "Whether the standby DKIM slot is ready for rotation.",
      "example": true
    }
  },
  "required": [
    "object",
    "id",
    "created_at",
    "updated_at",
    "domain",
    "account_id",
    "dns_records",
    "dns_valid"
  ]
}