AhaSend · Schema

UpdateDomainRequest

UpdateDomainRequest schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
tracking_subdomain string Optional custom tracking subdomain. Omit to leave the current value unchanged.
return_path_subdomain string Optional custom return-path subdomain. Omit to leave the current value unchanged.
subscription_subdomain string Optional custom subscription management subdomain. Omit to leave the current value unchanged.
media_subdomain string Optional custom media subdomain. Omit to leave the current value unchanged.
dkim_rotation_interval_days integer Optional custom DKIM rotation interval in days. Omit to leave the current value unchanged. Only supported for managed DNS domains on eligible plans.
View JSON Schema on GitHub

JSON Schema

openapi-v2-update-domain-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-update-domain-request-schema.json",
  "title": "UpdateDomainRequest",
  "description": "UpdateDomainRequest schema from AhaSend API",
  "type": "object",
  "properties": {
    "tracking_subdomain": {
      "type": "string",
      "description": "Optional custom tracking subdomain. Omit to leave the current value unchanged.",
      "example": "mail.example.com"
    },
    "return_path_subdomain": {
      "type": "string",
      "description": "Optional custom return-path subdomain. Omit to leave the current value unchanged.",
      "example": "mail.example.com"
    },
    "subscription_subdomain": {
      "type": "string",
      "description": "Optional custom subscription management subdomain. Omit to leave the current value unchanged.",
      "example": "mail.example.com"
    },
    "media_subdomain": {
      "type": "string",
      "description": "Optional custom media subdomain. Omit to leave the current value unchanged.",
      "example": "mail.example.com"
    },
    "dkim_rotation_interval_days": {
      "type": "integer",
      "description": "Optional custom DKIM rotation interval in days. Omit to leave the current value unchanged. Only supported for managed DNS domains on eligible plans.",
      "example": 1
    }
  },
  "example": {
    "tracking_subdomain": "click",
    "return_path_subdomain": "mail",
    "subscription_subdomain": "preferences",
    "media_subdomain": "media",
    "dkim_rotation_interval_days": 45
  }
}