AhaSend · Schema

CreateDomainRequest

CreateDomainRequest schema from AhaSend API

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

Properties

Name Type Description
domain string Fully qualified domain name
dkim_private_key string DKIM Private Key for the domain. Only RSA keys with a minimum key size of 2048 bits are supported. **Note:** This parameter is only supported on [Platform Partner](https://ahasend.com/partners) accoun
tracking_subdomain string Optional custom tracking subdomain. Omit to use the default on create.
return_path_subdomain string Optional custom return-path subdomain. Omit to use the default on create.
subscription_subdomain string Optional custom subscription management subdomain. Omit to use the default on create.
media_subdomain string Optional custom media subdomain. Omit to use the default on create.
dkim_rotation_interval_days integer Optional custom DKIM rotation interval in days. Only supported for managed DNS domains on eligible plans.
View JSON Schema on GitHub

JSON Schema

openapi-v2-create-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-create-domain-request-schema.json",
  "title": "CreateDomainRequest",
  "description": "CreateDomainRequest schema from AhaSend API",
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "format": "hostname",
      "description": "Fully qualified domain name",
      "example": "mail.example.com"
    },
    "dkim_private_key": {
      "type": "string",
      "description": "DKIM Private Key for the domain. Only RSA keys with a minimum key size of 2048 bits are supported.\n\n**Note:** This parameter is only supported on [Platform Partner](https://ahasend.com/partners) accounts.\n",
      "example": "aha-sk-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "tracking_subdomain": {
      "type": "string",
      "description": "Optional custom tracking subdomain. Omit to use the default on create.",
      "example": "mail.example.com"
    },
    "return_path_subdomain": {
      "type": "string",
      "description": "Optional custom return-path subdomain. Omit to use the default on create.",
      "example": "mail.example.com"
    },
    "subscription_subdomain": {
      "type": "string",
      "description": "Optional custom subscription management subdomain. Omit to use the default on create.",
      "example": "mail.example.com"
    },
    "media_subdomain": {
      "type": "string",
      "description": "Optional custom media subdomain. Omit to use the default on create.",
      "example": "mail.example.com"
    },
    "dkim_rotation_interval_days": {
      "type": "integer",
      "description": "Optional custom DKIM rotation interval in days. Only supported for managed DNS domains on eligible plans.",
      "example": 1
    }
  },
  "required": [
    "domain"
  ],
  "example": {
    "domain": "example.com",
    "tracking_subdomain": "click",
    "return_path_subdomain": "mail",
    "subscription_subdomain": "preferences",
    "media_subdomain": "media",
    "dkim_rotation_interval_days": 45
  }
}