Settings

Update the email theme setting

PATCH/settings/email-theme
email-templates:writeupdate_email_theme_settingsIdempotent

Sets the theme every platform email uses and returns the setting. The change applies to the platform organisation for every organisation on the platform. dry_run shows the result without saving. Emits email_theme_settings.updated to the token organisation's subscribers only when the theme or its inheritance changed; sends no email. Sending the previous theme undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · EmailThemeSettingsUpdate

  • themestring#

    The theme every platform email uses. delio is the platform default, institutional is formal, boutique is refined, family-office is understated, heritage is traditional, clean is minimal and corporate is structured.

    One of: delio, institutional, boutique, family-office, heritage, clean, corporate
{
  "theme": "corporate"
}

Responses

200

The email theme setting after the change.

EmailThemeSettings
{
  "data": {
    "theme": "delio",
    "inherited": true
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/settings/email-theme\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "theme": "corporate"
}'