Email Branding

Create or update email branding

Creates or replaces the email template branding for a realm. Triggers asynchronous theme generation and deployment.

Required scope: branding:write

put/clusters/{cluster_id}/realms/{realm}/branding/email

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/realms/{realm}/branding/email
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required
realmstring required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

Example:customer-portal

Headers

API-Version'2026-06-01.beta' required

Request body

primary_colorstring

CSS hex color code.

header_logo_light_urlstring uri
header_logo_dark_urlstring uri
company_urlstring uri
footer_company_namestring
footer_textstring
show_powered_byboolean

Display a 'Powered by Skycloak' line in the email footer. Hiding it requires a plan that allows removing branding; otherwise it stays on. Omitted means unchanged.

Example request

{
  "primary_color": "#1a73e8"
}

Response

The request has succeeded.

cluster_idstring uuid required
realmstring required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

primary_colorstring

CSS hex color code.

header_logo_light_urlstring uri

Logo URL for light-background email clients.

header_logo_dark_urlstring uri

Logo URL for dark-background email clients.

company_urlstring uri

URL of the company website linked from the email footer.

footer_company_namestring
footer_textstring
show_powered_byboolean

Display a 'Powered by Skycloak' line in the email footer.

status'applying' | 'applied' | 'failed' required
applied_atstring date-time

Timestamp of the most recent successful deployment to Keycloak.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "realm": "customer-portal",
  "primary_color": "#1a73e8"
}

Changes

No recorded changes to this operation across all 1 revision of this API.