Skip to main content
POST
/
api
/
v1
/
accounts
/
{accountId}
/
email
/
test
Send test email
curl --request POST \
  --url https://api.example.com/api/v1/accounts/{accountId}/email/test \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetEmail": "[email protected]",
  "templateType": "invitation",
  "widgetConfiguration": {
    "props": {
      "vortex.email.template.invitation.body": {
        "value": {
          "root": {}
        }
      },
      "vortex.email.template.invitation.theme": {
        "value": {}
      }
    }
  },
  "templateVariables": {
    "user-name": "John Doe",
    "company-name": "Acme Corp"
  },
  "reminderNumber": 1,
  "nudgeNumber": 1
}
'
{
  "success": true,
  "message": "Test email queued successfully"
}

Path Parameters

​
accountId
string
required

Body

application/json
​
targetEmail
string
required
​
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"