Kong · Schema

PortalEmailConfig

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id string
domain_name string The domain name used for sending emails. Null means default.
from_name string The name displayed in the 'From' field of emails.
from_email string The email address used in the 'From' field.
reply_to_email string The email address used in the 'Reply-To' field. 'Reply-To' header is omitted when null.
created_at object
updated_at object
View JSON Schema on GitHub

JSON Schema

kong-portalemailconfig-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PortalEmailConfig",
  "title": "PortalEmailConfig",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "readOnly": true
    },
    "domain_name": {
      "description": "The domain name used for sending emails. Null means default.",
      "type": "string",
      "nullable": true
    },
    "from_name": {
      "description": "The name displayed in the 'From' field of emails.",
      "type": "string",
      "nullable": true
    },
    "from_email": {
      "description": "The email address used in the 'From' field.",
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "reply_to_email": {
      "description": "The email address used in the 'Reply-To' field. 'Reply-To' header is omitted when null.",
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "from_name",
    "from_email",
    "reply_to_email",
    "created_at",
    "updated_at"
  ]
}