Email Notification Sender API
Trigger various system Email Notifications via the public API endpoint.
POST
Email Sender Case
Triggers the sending of the Case Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/case
Data / Response:
{
"CaseId": 0
}
Status 204
POST
Email Sender Confirm Email
Triggers the sending of the Confirm Email Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/confirm-email
Data / Response:
{
"Email": "string"
}
Status 204
POST
Email Sender Deferred Order Payment
Triggers the sending of the Deferred Order Payment Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/deferred-order-payment
Data / Response:
{
"OrderId": 0
}
Status 204
POST
Email Sender Gift Voucher
Triggers the sending of the Gift Vouchure Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/gift-voucher
Data / Response:
{
"GiftVoucherId": 0
}
Status 204
POST
Email Sender Invoice
Triggers the sending of the Invoice Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/invoice
Data / Response:
{
"OrderId": 0
}
Status 204
POST
Email Sender Low Stock
Triggers the sending of the Low Stock Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/low-stock
Data / Response:
{
"OrderId": 0
}
Status 204
POST
Email Sender Module Item
Triggers the sending of the Module Item Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/module-item
Data / Response:
{
"Email": "string",
"ModuleItemId": 0,
"EmailMessageEvent": "None"
}
Status 204
POST
Email Sender Password Retrieve
Triggers the sending of the Password Retrieve Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/password-retrieve-email
Data / Response:
{
"Email": "string"
}
Status 204
POST
Email Sender Quote
Triggers the sending of the Quote Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/quote
Data / Response:
{
"OrderId": 0
}
Status 204
POST
Email Sender Restore Admin User Password
Triggers the sending of the Restore Admin User Password Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/restore-admin-user-password
Data / Response:
{
"Email": "string"
}
Status 204
POST
Email Sender Secure Zone Login Details
Triggers the sending of the Secure Zone Login Details Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/secure-zone-login-details
Data / Response:
{
"Email": "string"
}
Status 204
POST
Email Sender Supplier
Triggers the sending of the Supplier Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/supplier
Data / Response:
{
"OrderId": 0
}
Status 204
POST
Email Sender Workflow
Triggers the sending of the Workflow Email Notification based on the data provided.
/api/v2/admin/email-notification-sender/workflows
Data / Response:
{
"Email": "string",
"OrderId": 0,
"CustomWorkflowIds": [
0
]
}
Status 204
Related Articles
- Email Notifications
Workflows
A Workflow is an action (or rule) that determines how a notification is handled. Workflows allow for greater control of email notifications that get sent when Forms are submitted on the front-end of your website. In this case we’re looking at Email Notifications. - Email Notifications
Emails
System email layouts can be managed here for additional Workflow Notification emails, Event registration follow-up emails and also eCommerce abandon cart emails (depending on your site plan and the extensions installed). - Email Notifications
Email Templates
Email Templates provide a top-level wrapper for one or more of your system email’s contents, allowing for consistent branding and styling across emails sent via the CMS (such as Workflows, Autoresponders, reminders, follow-ups, abandon cart emails, etc.). - Email Notifications
System Emails
System emails are emails that are sent when a particular action is carried out on the website and/or via the admin. - Liquid Objects & Usage
{{ member }} object
This liquid object will output the Member's details of whom submitted a Form. You can... - Liquid Objects & Usage
{{ workflow }} object
This liquid object will output the Workflow details of a submitted Form. You can use...
External Resources
There are currently no external resources available.
Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.
Questions?
We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.