Mail

Send email with metadata tracking (optional attachments)

Send email and create log entry for tracking delivery and engagement. Supports attachment via multipart/form-data.

post/mail/send

Request

Request body multipart/form-data

tostring required

Recipient email address

subjectstring required

Email subject

recipientNamestring required

Recipient name

htmlContentstring

HTML body content

templateType'order-confirmation' | 'password-reset' | 'verification'

Email template type

orderIdnumber

Related order ID for tracking

customerIdnumber

Related customer ID for tracking

metadataobject

Additional metadata to store with the email log

filesstring[]

Array of files to attach (optional)

Example request

{
  "to": "user@example.com",
  "subject": "Welcome to Land Registry",
  "recipientName": "John Doe",
  "htmlContent": "<p>Welcome to our platform</p>",
  "orderId": 1,
  "customerId": 1,
  "metadata": {
    "orderNumber": "ORD-2025-001",
    "invoiceId": 123,
    "productName": "Land Registry Service"
  }
}

Response

Email sent successfully

Changes

No recorded changes to this operation across all 7 revisions of this API.