Skip to main content
POST
/
test
/
email-notifications
Send test email notifications (NBG)
curl --request POST \
  --url https://{host}/test/email-notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": "email_account_verified",
  "userId": "64f0c51e7fb3fc001234abcd",
  "customData": {
    "payment_url": "/"
  }
}
'
{
  "notificationId": "674a1b2c3d4e5f6789012345",
  "status": "Sent"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wealthyhood.com/llms.txt

Use this file to discover all available pages before exploring further.

These test endpoints are only available in development and staging environments. They are disabled in production.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
templateId
enum<string>
required

NBG transactional email template_id sent to /v1/notifications/email/transactional.

Available options:
email_account_verified,
email_monthly_investment,
email_account_deletion_requested,
email_account_deletion_completed,
email_account_deletion_completed_inactive
Example:

"email_account_verified"

​
userId
string
required

MongoDB ObjectId of the NBG user to email.

Pattern: ^[a-f0-9]{24}$
Example:

"64f0c51e7fb3fc001234abcd"

​
customData
object

Optional key/value map sent to NBG as custom_data.

Example:
{ "payment_url": "/" }

Response

Notification document created; dispatch attempted per NBG availability and user settings.

​
notificationId
string
required

MongoDB id of the created notification document.

​
status
enum<string>
required

Notification status after create/send attempt.

Available options:
Pending,
Sent,
Skipped