Modules
Email Theme Module Documentation
An Email Theme contains the global CSS stylesheet and typography rules applied to your transactional email communications. It standardises font families, container widths, color palettes, call-to-action (CTA) buttons, and element padding across all outgoing emails.
How it works
- Create an email theme — define a unique name, description, and status for your design theme.
- Customise CSS rules — write custom CSS inside the
stylefield to style.container,.content,.field-table,.message-box,.cta-button-primary, and other template components. - Inject into emails — the platform compiles theme styles directly into your rendered Email Templates during transactional delivery.
Fields
Basic information
| Field | Type | Required | Max length | Description |
|---|---|---|---|---|
name | string | ✅ | 256 | The unique name of the email theme |
description | string | ❌ | 1 024 | A brief description of the email theme |
status | enum | ✅ | — | draft · live · paused |
Styling settings
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
style | text | ❌ | (Default CSS stylesheet) | Global CSS stylesheet injected into email templates |
The default style stylesheet includes pre-configured styles for standard email layouts:
Code
Real-world examples
🎨 Modern Brand Email Theme
Code
Access & permissions
| Caller | Allowed operations | Notes |
|---|---|---|
| Admin | CREATE · GET · LIST · UPDATE · DELETE | Full management access |
| End user | (none) | No access |
| Guest user | (none) | No access |
Related resources
| Resource | Description |
|---|---|
| Email Template | Body content templates styled by email themes |
| Email Header | Header wrappers placed above template content |
| Email Footer | Footer wrappers appended below template content |
| Notification | Active notification rules executing email templates |
API reference
See the API Reference for full request/response schemas and interactive examples for:
GET /schema/email_theme/record— list email themesPOST /schema/email_theme/record— create an email themeGET /schema/email_theme/record/{id}— get an email theme by IDPATCH /schema/email_theme/record/{id}— update an email themeDELETE /schema/email_theme/record/{id}— delete an email theme
Last modified on