Email

Description

The email module provides management of email blocks, templates with i18n support, and user email verification.

Events

Following events are transmitted via the websocket.

EMAIL_BLOCK_ADD

EMAIL_BLOCK_UPDATE

EMAIL_BLOCK_DELETE

EMAIL_TEMPLATE_ADD

EMAIL_TEMPLATE_UPDATE

EMAIL_TEMPLATE_DELETE

EMAIL_USER_REGISTER

EMAIL_USER_VERIFY

Fired when a new email block is created. This event requires read access to the resource email.blocks.

Name	Description
type stringconstant	Constant value: EMAIL_BLOCK_ADD
uuid string	Unique identifier for the block
name string	Human-readable name for the block
content string	HTML content of the block
createdAt integer	Creation timestamp
updatedAt integeroptional	Last update timestamp

API

Endpoints

GET

List Email Blocks

GET

Get Email Block

DEL

Delete Email Block

GET

List Email Templates

GET

Get Email Template

DEL

Delete Email Template

GET

Render Email Template

GET

Get Email Status

POST

Register Email

POST

Verify Email

DEL

Reset Email

List Email Blocks

Returns all email building blocks (headers, footers, buttons, etc.)

GET

/api/v1/email/blocks

Access

This endpoint requires read permission for the resource email.blocks.

Response

Name	Description

Get Email Block

Returns a single email block by UUID

GET

/api/v1/email/blocks/:blockUuid

Access

This endpoint requires read permission for the resource email.blocks.

URL Parameter

Name	Description
blockUuid string	Unique identifier for the block

Response

Name	Description
uuid string	Unique identifier for the block
name string	Human-readable name for the block
content string	HTML content of the block
createdAt integer	Creation timestamp
updatedAt integeroptional	Last update timestamp

Delete Email Block

Deletes an email block

DELETE

/api/v1/email/blocks/:blockUuid

Access

This endpoint requires delete permission for the resource email.blocks.

URL Parameter

Name	Description
blockUuid string	Unique identifier for the block

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

List Email Templates

Returns all email templates

GET

/api/v1/email/templates

Access

This endpoint requires read permission for the resource email.templates.

Response

Name	Description

Get Email Template

Returns a single email template by UUID

GET

/api/v1/email/templates/:templateUuid

Access

This endpoint requires read permission for the resource email.templates.

URL Parameter

Name	Description
templateUuid string	Unique identifier for the template

Response

Name	Description
uuid string	Unique identifier for the template
name string	Human-readable name for the template
blocks array	Aray of block UUIDs referenced in the template
subject string	Email subjec template wih `text:key` and `param` placeholders
body string	Email body HTML with `text:key`, `block:uuid`, and `param` placeholders
translations dictionary	Translations keyed by language code, containing text key to string mappings
parameters array	List of required parameter names like `code`, `username`
createdAt integer	Creation timestamp
updatedAt integeroptional	Last update timestamp

Delete Email Template

Deletes an email template

DELETE

/api/v1/email/templates/:templateUuid

Access

This endpoint requires delete permission for the resource email.templates.

URL Parameter

Name	Description
templateUuid string	Unique identifier for the template

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

Render Email Template

Renders an email template with the specified locale and parameters. Replaces block:uuid placeholders with block content and param placeholders with provided values.

GET

/api/v1/email/render/:templateUuid

Access

This endpoint requires read permission for the resource email.templates.

URL Parameter

Name	Description
templateUuid string	Unique identifier for the template

Query Parameter

Name	Description
locale string	Locale code for the translation (e.g., en-GB, de-DE) Pattern: ^[a-z]{2}(-[A-Z]{2})?$

Response

Name	Description
subject string	Rendered subject with parameters replaced
body string	Rendered body with blocks and parameters replaced

Get Email Status

Returns the current user`s email verification status

GET

/api/v1/email/user

Response

Name	Description
status stringenum	Possible values: unregistered, pending_verification, verified
email stringoptional

Register Email

Registers an email address for the current user and sends a verification code. Can be called again to resend the code if email is not yet verified.

POST

/api/v1/email/register

Request Body

Name	Description
email string	Email address to register

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

Verify Email

Verifies a user`s email using the 6-digit code

POST

/api/v1/email/verify

Request Body

Name	Description
code string	6-digit verification code

Response

Name	Description
status stringenum	Possible values: unregistered, pending_verification, verified
verifiedAt numberoptional

Reset Email

Removes the current user`s email registration, reverting their status to unregistered.

DELETE

/api/v1/email/user

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.