API docs by Redocly

O.Z.O.R.A. Emails API (0.0.1)

Download OpenAPI specification:

Email sending service.

Git Commit ID: 006adfb87dcb9e9045b039be0321535180ebb9b1
Software Version: 0.0.1
Build: 2026-08-18 20:24:34

Defaults

Get the current defaults for other services (internal only)

Internal endpoint used by other services to initialize their local defaults.json during startup. Only service-to-service calls (service JWT) are accepted.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "defaults": {
    },
  • "revision": 1786190488163
}

Edit one or more defaults values

Updates the value of one or more defaults records, writes a log entry for each changed record, then distributes the new defaults to the consuming services (accounts, tickets, items, vehicles). Requires the Priv emails_defaults_edit permission.

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects non-empty

One entry per defaults record to update. Each id must be unique within the request; a repeated id is rejected with 400.

Responses

Request samples

Content type
application/json
{
  • "changes": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Defaults updated.",
  • "updated": [
    ],
  • "distribution": {
    }
}

Get the defaults change logs

Returns every log entry that has a value in the id_default column. Requires the Priv emails_defaults_edit permission.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "logs": [
    ]
}

List all defaults

Returns every row from the defaults table, ordered by keyword. Requires the Priv emails_defaults_edit permission.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "defaults": [
    ]
}

Error

Report frontend error

Receives a frontend error report, logs it to the database, and sends a notification email to the configured LOG_EMAIL_TO addresses. Only processes reports in production environment.

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "error_info": {
    },
  • "error": {
    },
  • "browser": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Error reported"
}

Emails

Send email

Queues an email for sending via the emails microservice. The email is saved to the database and will be sent by the scheduled child process.

Authorizations:
bearerAuth
Request Body schema: application/json
required
string or object

Sender address. Falls back to backup SMTP auth user if not provided.

to
required
string <email>

Recipient email address

subject
required
string

Email subject line

html
required
string

HTML email body

cc
string

CC email address(es)

flagPriority
boolean

If true, email is prioritized

Array of objects

Array of file attachments

Responses

Request samples

Content type
application/json
{
  • "from": "string",
  • "to": "[email protected]",
  • "subject": "Welcome to the platform",
  • "html": "<h1>Hello</h1><p>Welcome!</p>",
  • "cc": "string",
  • "flagPriority": true,
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Email queued for sending.",
  • "id": 42
}