Skip to main content
The system-emails resource allows admins to preview and send test copies of transactional emails (welcome messages, access approvals, access requests). Both actions are restricted to internal admin users.

Preview system email

Renders the HTML preview of a system email template.
string
required
Must be "system-emails"
string
required
Must be "preview"
object
required
boolean
object

Send test email

Sends a test copy of a system email template to a specified recipient.
string
required
Must be "system-emails"
string
required
Must be "sendTest"
object
required
boolean

Error codes