UpdateDomainInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/forward-email/main/json-schema/forward-email-update-domain-input-schema.json",
  "title": "UpdateDomainInput",
  "x-generated": "2026-10-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/forward-email-openapi.json#/components/schemas/UpdateDomainInput",
  "type": "object",
  "properties": {
    "smtp_port": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ],
      "description": "Custom port to configure for SMTP forwarding (default is '25')"
    },
    "has_adult_content_protection": {
      "type": "boolean",
      "description": "Whether to enable Spam Scanner adult content protection on this domain"
    },
    "has_phishing_protection": {
      "type": "boolean",
      "description": "Whether to enable Spam Scanner phishing protection on this domain"
    },
    "has_executable_protection": {
      "type": "boolean",
      "description": "Whether to enable Spam Scanner executable protection on this domain"
    },
    "has_virus_protection": {
      "type": "boolean",
      "description": "Whether to enable Spam Scanner virus protection on this domain"
    },
    "has_recipient_verification": {
      "type": "boolean",
      "description": "Global domain default for whether to require alias recipients to click an email verification link for emails to flow through"
    },
    "ignore_mx_check": {
      "type": "boolean",
      "description": "Whether to ignore the MX record check on the domain for verification (mainly for advanced MX routing setups)"
    },
    "allow_subdomain_forwarding": {
      "description": "Allow wildcard subdomain forwarding. When enabled on a paid plan (Enhanced Protection or Team), any subdomain that has no DNS records of its own inherits the forwarding configuration published at this domain’s root (apex). Verified ownership is required: the apex must publish a forward-email-site-verification record matching this domain. This setting does not apply to the free plan.",
      "type": "boolean"
    },
    "has_delivery_logs": {
      "type": "boolean",
      "description": "Opt-in to store headers and metadata (excluding message content) for successfully forwarded, webhook-sent, outbound SMTP, and IMAP-delivered emails, with logs retained for 7 days. This feature helps you monitor and troubleshoot email delivery performance with detailed insights into successful transmissions."
    },
    "retention_days": {
      "type": "integer",
      "minimum": 0,
      "maximum": 30,
      "description": "Number of days to store outbound SMTP emails (0 = purge immediately)"
    },
    "bounce_webhook": {
      "oneOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "type": "boolean",
          "enum": [
            false
          ]
        }
      ],
      "description": "Webhook URL to receive bounce notifications, or false to disable"
    },
    "max_quota_per_alias": {
      "type": "string",
      "description": "Storage quota per alias (e.g. '1 GB', parsed into bytes)"
    },
    "has_custom_s3": {
      "type": "boolean",
      "description": "Whether to enable custom S3-compatible storage for IMAP/SQLite backups on this domain"
    },
    "s3_endpoint": {
      "type": "string",
      "format": "uri",
      "description": "Custom S3-compatible endpoint URL (e.g. https://s3.us-east-1.amazonaws.com)"
    },
    "s3_access_key_id": {
      "type": "string",
      "description": "S3 access key ID. Encrypted at rest. Leave blank when updating to keep existing value."
    },
    "s3_secret_access_key": {
      "type": "string",
      "description": "S3 secret access key. Encrypted at rest. Leave blank when updating to keep existing value."
    },
    "s3_region": {
      "type": "string",
      "description": "S3 region (e.g. us-east-1, auto). Defaults to auto."
    },
    "s3_bucket": {
      "type": "string",
      "minLength": 3,
      "maxLength": 63,
      "pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
      "description": "S3 bucket name for storing backups. The bucket must already exist and must not be publicly accessible."
    },
    "allowlist": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of allowlisted senders (IP addresses, fully qualified domain names, email addresses, or wildcard TLDs). When set, only mail from these senders will be accepted. Replaces the existing list. Wildcard public-suffix rules may contain multiple labels, for example `*.gov.co` and `*.gov.br`; they match senders under that exact suffix."
    },
    "denylist": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of denylisted senders (IP addresses, fully qualified domain names, email addresses, or wildcard TLDs). Mail from these senders will be rejected. Replaces the existing list. Wildcard public-suffix rules may contain multiple labels, for example `*.gov.co` and `*.gov.br`; they match senders under that exact suffix."
    }
  }
}