Transaction Email
/ Send email with template (transactional)
Send email with template (transactional)
Method: POST
https://api-prod.enotifiers.com/api/V1/service/emailTemplate/sendRequest details
| Parameter | Description | Example |
|---|---|---|
|
emailName string |
Name of the email. | Order Confirmation Email |
|
variables Dictionary |
Variables to be used in the email template. | {"orderNumber": "ORD123456"} |
|
to string |
Email address of the recipient. | customer@example.com |
|
subject string |
Subject of the email. | Order Confirmation for Your Recent Purchase |
|
templateName string |
Name of the email template to be used. | order_confirmation_template |
|
templateCategory string |
Category of the email template. | Order Confirmations |
Curl code
curl --location
'https://api-prod.enotifiers.com/api/V1/service/emailTemplate/send' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {{Authorization}}' \
--data-raw '{
"emailName": "email_test",
"variables": {"orderNumber": "ORD123456"},
"to": "customer@example.com",
"subject": "email_test",
"templateName": "test_edit_test",
"templateCategory": "testing_1"
}'Success response details
| Parameter | Description | Example |
|---|---|---|
| status String |
Indicates the success status of the API operation |
success |
| code String |
Provides the status code indicating the success of the request. | 200 |
| message String |
A descriptive message confirming the success of the operation. | It states that the email was sent successfully. |
| data.MessageId String |
Unique identifier for the sent email message. | "0109018e742e100c-d0df344d-7abe-41c3-a583-143d624fa947-000000" |
{
"status": "success",
"code": "200",
"message": "Mail Sent Successfully",
"data": {
"MessageId": "0745618e742e100c-d0df344d-7abe-41c3-a583-143d624fa947-000000"
}
}Failure response details
| Parameter | Description | Example |
|---|---|---|
| status String |
Indicates the overall status of the API request. |
failed |
| code String |
Provides the HTTP status code corresponding to the failure. |
400 |
| message String |
Provides the reason for the error | Email not found. |
| data.error String |
Specific error message providing more context about the issue. | No document found for the given email name. |
{
"status": "failed",
"code": "400",
"message": "Email not found.",
"data": {
"error": "No document found for the given email name."
}
}
