Skip to content
HOC Site Docs
English
Esc
navigateopen⌘Jpreview

Email

Configure how transactional email is sent: platform delivery or your own SMTP. Responses never return the raw SMTP password; they expose hasSmtpPassword instead.

Read public email settings.

GET /api/v1/{locale}/{websiteId}/email-settings

Update email settings (website superadmin).

PUT /api/v1/{locale}/{websiteId}/email-settings
{
  "provider": "platform | smtp",
  "smtpHost": "string?",
  "smtpPort": 587,
  "smtpSecure": false,
  "smtpUsername": "string?",
  "smtpPassword": "string?",
  "clearSmtpPassword": false,
  "fromEmail": "string?",
  "fromName": "string?",
  "replyTo": "string?"
}

MCP: get_email_settings, update_email_settings.

Was this page helpful?