Send Test Email
This endpoint allows you to test email templates by sending a test email. It returns the status of the sent email with a success and message body that can be used for further queries.
Send a test email using this POST
Request
BASE_URL/send/test/email
- Authorization ->
Bearer [ACCESS_TOKEN]
- Content-Type ->
multipart/form-data
Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
templateName | string | yes* | The name of the template |
templateVariables | string[] | yes* | An array of template variables represented by #VARIABLE_NAME# e.g ['#EMAIL#', '#NAME#'] |
templateFile | object | yes* | Supported file type is only html |
testEmail | string | yes* | A test email to recieve the email template |
testUser | string | yes* | A test user name as reciever's name |
Responses
Success
Status Code: 200
{
"success": true,
"message": "Test email sent successfully"
}
Validation Error Response
Status Code: 200
{
"success": false,
"message": "Message Returned"
}
Error
Status Code: 400
{
"success": false,
"message": "Message Returned"
}