API docs by Redocly

O.Z.O.R.A. Emails API

Download OpenAPI specification:

Email sending service.

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
}