v1.0.0 Stable

Email Templates

What This Option Does

Email Templates module manages system email subjects and content used in automated flows.

How Admin Uses This

  1. Open template list and choose target template.
  2. Edit subject/body while preserving placeholder variables.
  3. Save updates.
  4. Trigger a test email workflow to validate output.

Screenshot Placeholder

Email Templates Screenshot Placeholder
Add screenshot file at documentaion/assets/images/backoffice-email-temaplates.png

Enterprise Technical Specification

Business Capabilities

  • Template list/detail/update
  • Template status control

API Contract Surface

Primary API endpoints used by this module:

  • /api/v1/backoffice/email-templates
  • /api/v1/backoffice/email-templates/{id}
  • /api/v1/backoffice/email-templates/{id}/status

Permission Blueprint

Recommended permission keys for production role design:

  • backoffice.email_template.view
  • backoffice.email_template.edit

Operational Risk and Control Notes

  • Broken template placeholders cause failed emails
  • Enable activity logging and include company_id, actor ID, and target entity ID in audit traces.
  • Apply least-privilege principle for create/update/delete actions.

QA Verification Checklist

  • Validate list API load, empty-state behavior, and pagination consistency.
  • Verify create/update/delete response contract (status, message, data).
  • Confirm permission denial responses for unauthorized roles.
  • Test edge inputs and invalid IDs for safe error handling.