Skip to main content
POST
/
api
/
v1
/
accounts
/
{accountId}
/
email
/
test
{
  "success": true,
  "message": "Test email queued successfully"
}

Path Parameters

​
accountId
string
required

Body

application/json
​
targetEmail
string
required
Example:

"admin@example.com"

​
templateType
enum<string>
required

Type of email template to test

Available options:
invitation,
reminder,
nudge,
acceptance
Example:

"invitation"

​
widgetConfiguration
object
required

Widget configuration containing email templates

Example:
{
  "props": {
    "vortex.email.template.invitation.body": { "value": { "root": {} } },
    "vortex.email.template.invitation.theme": { "value": {} }
  }
}
​
templateVariables
object

Template variables to substitute in the email

Example:
{
  "user-name": "John Doe",
  "company-name": "Acme Corp"
}
​
reminderNumber
number

Reminder number (for reminder emails)

Example:

1

​
nudgeNumber
number

Nudge number (for nudge emails)

Example:

1

Response

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Test email queued successfully"